jekyll-cli 2.0.0
Jekyll Blog CLI Tool
Requires Python: >=3.12

# Jekyll CLI

Jekyll Blog CLI Tool.

**Usage**:

```console
$ blog [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--version`: Print version and exit.
* `--help`: Show this message and exit.

**Commands**:

* `serve`: Start blog server locally through jekyll.
* `build`: Build jekyll site.
* `info`: Show info about post or draft.
* `list`: List all posts and drafts or find items by...
* `open`: Open post or draft in editor.
* `draft`: Create a draft.
* `post`: Create a post.
* `remove`: Remove a post or draft.
* `publish`: Publish a draft.
* `unpublish`: Unpublish a post.
* `init`: Initialize the application interactively.
* `rename`: Rename a post or draft.
* `sync`: Synchronize article index from &lt;root&gt;.
* `config`: Configuration Subcommands.

## `blog serve`

Start blog server locally through jekyll.

**Usage**:

```console
$ blog serve [OPTIONS]
```

**Options**:

* `--draft / --no-draft`: Start blog server with drafts.  [default: no-draft]
* `--port INTEGER`: Listen on the given port.  [default: 4000]
* `--help`: Show this message and exit.

## `blog build`

Build jekyll site.

**Usage**:

```console
$ blog build [OPTIONS]
```

**Options**:

* `--draft / --no-draft`: Build including drafts.  [default: no-draft]
* `--help`: Show this message and exit.

## `blog info`

Show info about post or draft.

**Usage**:

```console
$ blog info [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of post or draft.  [required]

**Options**:

* `--help`: Show this message and exit.

## `blog list`

List all posts and drafts or find items by name.

**Usage**:

```console
$ blog list [OPTIONS]
```

**Options**:

* `-d, --draft`: List only all drafts.
* `-p, --post`: List only all posts.
* `--help`: Show this message and exit.

## `blog open`

Open post or draft in editor.

**Usage**:

```console
$ blog open [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of post or draft.  [required]

**Options**:

* `-e, --editor TEXT`: Open item in given editor
* `--help`: Show this message and exit.

## `blog draft`

Create a draft.

**Usage**:

```console
$ blog draft [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of draft item.  [required]

**Options**:

* `-t, --title TEXT`: Title of draft.
* `-c, --class TEXT`: Categories of draft.
* `-g, --tag TEXT`: Tags of draft.
* `-e, --editor TEXT`: Open draft in given editor.
* `-o, --open`: Open draft automatically.
* `--help`: Show this message and exit.

## `blog post`

Create a post.

**Usage**:

```console
$ blog post [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of post item.  [required]

**Options**:

* `-t, --title TEXT`: Title of post.
* `-c, --class TEXT`: Categories of post.
* `-g, --tag TEXT`: Tags of post.
* `-e, --editor TEXT`: Open post in given editor.
* `-o, --open`: Open post automatically.
* `--help`: Show this message and exit.

## `blog remove`

Remove a post or draft.

**Usage**:

```console
$ blog remove [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of post or draft.  [required]

**Options**:

* `--help`: Show this message and exit.

## `blog publish`

Publish a draft.

**Usage**:

```console
$ blog publish [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of draft.  [required]

**Options**:

* `--help`: Show this message and exit.

## `blog unpublish`

Unpublish a post.

**Usage**:

```console
$ blog unpublish [OPTIONS] NAME
```

**Arguments**:

* `NAME`: Name of post.  [required]

**Options**:

* `--help`: Show this message and exit.

## `blog init`

Initialize the application interactively.

**Usage**:

```console
$ blog init [OPTIONS]
```

**Options**:

* `--help`: Show this message and exit.

## `blog rename`

Rename a post or draft.

**Usage**:

```console
$ blog rename [OPTIONS] NAME NEW_NAME
```

**Arguments**:

* `NAME`: Name of post or draft.  [required]
* `NEW_NAME`: New name.  [required]

**Options**:

* `--help`: Show this message and exit.

## `blog sync`

Synchronize article index from &lt;root&gt;.

**Usage**:

```console
$ blog sync [OPTIONS]
```

**Options**:

* `--help`: Show this message and exit.

## `blog config`

Configuration Subcommands.

**Usage**:

```console
$ blog config [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--help`: Show this message and exit.

**Commands**:

* `list`: List all configurations.
* `set`: Set a configuration.
* `reset`: Reset configuration.

### `blog config list`

List all configurations.

**Usage**:

```console
$ blog config list [OPTIONS]
```

**Options**:

* `--help`: Show this message and exit.

### `blog config set`

Set a configuration.

**Usage**:

```console
$ blog config set [OPTIONS] KEY VALUE
```

**Arguments**:

* `KEY`: Configuration key using dot-notation.  [required]
* `VALUE`: Configuration value.  [required]

**Options**:

* `--help`: Show this message and exit.

### `blog config reset`

Reset configuration.

**Usage**:

```console
$ blog config reset [OPTIONS]
```

**Options**:

* `--help`: Show this message and exit.