| Name | jekyll-cli JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | None |
| Summary | Jekyll Blog CLI Tool |
| upload_time | 2025-01-14 14:42:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jekyll CLI
Jekyll Blog CLI Tool.
**Usage**:
```console
$ blog [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--help`: Show this message and exit.
**Commands**:
* `build`: Build jekyll site.
* `config`: Configuration Subcommands.
* `deploy`: Deploy the site with the...
* `draft`: Create a draft.
* `info`: Show info about post or draft.
* `init`: Initialize the application interactively.
* `list`: List all posts and drafts or find items by...
* `open`: Open post or draft in editor.
* `post`: Create a post.
* `publish`: Publish a draft.
* `remove`: Remove a post or draft.
* `rename`: Rename a post or draft.
* `serve`: Start blog server locally through jekyll.
* `unpublish`: Unpublish a post.
## `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 config`
Configuration Subcommands.
**Usage**:
```console
$ blog config [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--help`: Show this message and exit.
**Commands**:
* `list`: List all configurations.
* `reset`: Reset default configuration.
* `set`: Set a configuration.
### `blog config list`
List all configurations.
**Usage**:
```console
$ blog config list [OPTIONS]
```
**Options**:
* `--help`: Show this message and exit.
### `blog config reset`
Reset default configuration.
**Usage**:
```console
$ blog config reset [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 deploy`
Deploy the site with the '<root>/jekyll-deploy.yml.'
**Usage**:
```console
$ blog deploy [OPTIONS]
```
**Options**:
* `--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 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 init`
Initialize the application interactively.
**Usage**:
```console
$ blog init [OPTIONS]
```
**Options**:
* `--help`: Show this message and exit.
## `blog list`
List all posts and drafts or find items by name.
**Usage**:
```console
$ blog list [OPTIONS] [NAME]
```
**Arguments**:
* `[NAME]`: Name of post or draft.
**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 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 publish`
Publish a draft.
**Usage**:
```console
$ blog publish [OPTIONS] NAME
```
**Arguments**:
* `NAME`: Name of draft. [required]
**Options**:
* `--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 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 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 unpublish`
Unpublish a post.
**Usage**:
```console
$ blog unpublish [OPTIONS] NAME
```
**Arguments**:
* `NAME`: Name of post. [required]
**Options**:
* `--help`: Show this message and exit.
Raw data
{
"_id": null,
"home_page": null,
"name": "jekyll-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "John Wei <wzy1048168235@163.com>",
"download_url": "https://files.pythonhosted.org/packages/98/c1/9de90d0707bab1f76d46c362c247f8ddd17b74459c081752e8916123db3f/jekyll_cli-1.2.1.tar.gz",
"platform": null,
"description": "# Jekyll CLI\n\nJekyll Blog CLI Tool.\n\n**Usage**:\n\n```console\n$ blog [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `build`: Build jekyll site.\n* `config`: Configuration Subcommands.\n* `deploy`: Deploy the site with the...\n* `draft`: Create a draft.\n* `info`: Show info about post or draft.\n* `init`: Initialize the application interactively.\n* `list`: List all posts and drafts or find items by...\n* `open`: Open post or draft in editor.\n* `post`: Create a post.\n* `publish`: Publish a draft.\n* `remove`: Remove a post or draft.\n* `rename`: Rename a post or draft.\n* `serve`: Start blog server locally through jekyll.\n* `unpublish`: Unpublish a post.\n\n## `blog build`\n\nBuild jekyll site.\n\n**Usage**:\n\n```console\n$ blog build [OPTIONS]\n```\n\n**Options**:\n\n* `--draft / --no-draft`: Build including drafts. [default: no-draft]\n* `--help`: Show this message and exit.\n\n## `blog config`\n\nConfiguration Subcommands.\n\n**Usage**:\n\n```console\n$ blog config [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `list`: List all configurations.\n* `reset`: Reset default configuration.\n* `set`: Set a configuration.\n\n### `blog config list`\n\nList all configurations.\n\n**Usage**:\n\n```console\n$ blog config list [OPTIONS]\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n### `blog config reset`\n\nReset default configuration.\n\n**Usage**:\n\n```console\n$ blog config reset [OPTIONS]\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n### `blog config set`\n\nSet a configuration.\n\n**Usage**:\n\n```console\n$ blog config set [OPTIONS] KEY VALUE\n```\n\n**Arguments**:\n\n* `KEY`: Configuration key using dot-notation. [required]\n* `VALUE`: Configuration value. [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog deploy`\n\nDeploy the site with the '<root>/jekyll-deploy.yml.'\n\n**Usage**:\n\n```console\n$ blog deploy [OPTIONS]\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog draft`\n\nCreate a draft.\n\n**Usage**:\n\n```console\n$ blog draft [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of draft item. [required]\n\n**Options**:\n\n* `-t, --title TEXT`: Title of draft.\n* `-c, --class TEXT`: Categories of draft.\n* `-g, --tag TEXT`: Tags of draft.\n* `-e, --editor TEXT`: Open draft in given editor.\n* `-o, --open`: Open draft automatically.\n* `--help`: Show this message and exit.\n\n## `blog info`\n\nShow info about post or draft.\n\n**Usage**:\n\n```console\n$ blog info [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of post or draft. [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog init`\n\nInitialize the application interactively.\n\n**Usage**:\n\n```console\n$ blog init [OPTIONS]\n```\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog list`\n\nList all posts and drafts or find items by name.\n\n**Usage**:\n\n```console\n$ blog list [OPTIONS] [NAME]\n```\n\n**Arguments**:\n\n* `[NAME]`: Name of post or draft.\n\n**Options**:\n\n* `-d, --draft`: List only all drafts.\n* `-p, --post`: List only all posts.\n* `--help`: Show this message and exit.\n\n## `blog open`\n\nOpen post or draft in editor.\n\n**Usage**:\n\n```console\n$ blog open [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of post or draft. [required]\n\n**Options**:\n\n* `-e, --editor TEXT`: Open item in given editor\n* `--help`: Show this message and exit.\n\n## `blog post`\n\nCreate a post.\n\n**Usage**:\n\n```console\n$ blog post [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of post item. [required]\n\n**Options**:\n\n* `-t, --title TEXT`: Title of post.\n* `-c, --class TEXT`: Categories of post.\n* `-g, --tag TEXT`: Tags of post.\n* `-e, --editor TEXT`: Open post in given editor.\n* `-o, --open`: Open post automatically.\n* `--help`: Show this message and exit.\n\n## `blog publish`\n\nPublish a draft.\n\n**Usage**:\n\n```console\n$ blog publish [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of draft. [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog remove`\n\nRemove a post or draft.\n\n**Usage**:\n\n```console\n$ blog remove [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of post or draft. [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog rename`\n\nRename a post or draft.\n\n**Usage**:\n\n```console\n$ blog rename [OPTIONS] NAME NEW_NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of post or draft. [required]\n* `NEW_NAME`: New name. [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `blog serve`\n\nStart blog server locally through jekyll.\n\n**Usage**:\n\n```console\n$ blog serve [OPTIONS]\n```\n\n**Options**:\n\n* `--draft / --no-draft`: Start blog server with drafts. [default: no-draft]\n* `--port INTEGER`: Listen on the given port. [default: 4000]\n* `--help`: Show this message and exit.\n\n## `blog unpublish`\n\nUnpublish a post.\n\n**Usage**:\n\n```console\n$ blog unpublish [OPTIONS] NAME\n```\n\n**Arguments**:\n\n* `NAME`: Name of post. [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n",
"bugtrack_url": null,
"license": null,
"summary": "Jekyll Blog CLI Tool",
"version": "1.2.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f9a1fbcf6a78bfcb30a99ee820f89ec16ef5f6698af56b8fda0da8adbc5ca7a9",
"md5": "751acd2dda3e2ad06ff84f8c8df8f92d",
"sha256": "7b4b1bd48702a4e96b0be811c5ee527f43a232f705efac6ed805a80f49e22c2f"
},
"downloads": -1,
"filename": "jekyll_cli-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "751acd2dda3e2ad06ff84f8c8df8f92d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 13872,
"upload_time": "2025-01-14T14:42:22",
"upload_time_iso_8601": "2025-01-14T14:42:22.753814Z",
"url": "https://files.pythonhosted.org/packages/f9/a1/fbcf6a78bfcb30a99ee820f89ec16ef5f6698af56b8fda0da8adbc5ca7a9/jekyll_cli-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "98c19de90d0707bab1f76d46c362c247f8ddd17b74459c081752e8916123db3f",
"md5": "85413aa431ac87f1ddc82591b062443c",
"sha256": "46870f8eaa59e67703ed5b59a268927bf23bbe2b7bda1d827cb147bcb7a23c49"
},
"downloads": -1,
"filename": "jekyll_cli-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "85413aa431ac87f1ddc82591b062443c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 20189,
"upload_time": "2025-01-14T14:42:25",
"upload_time_iso_8601": "2025-01-14T14:42:25.466981Z",
"url": "https://files.pythonhosted.org/packages/98/c1/9de90d0707bab1f76d46c362c247f8ddd17b74459c081752e8916123db3f/jekyll_cli-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 14:42:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jekyll-cli"
}
