Skip to main content

Jekyll CLI

Jekyll Blog CLI Tool.

Usage:

$ 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 <root>.
  • config: Configuration Subcommands.

blog serve

Start blog server locally through jekyll.

Usage:

$ 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:

$ 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:

$ 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:

$ 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:

$ 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:

$ 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:

$ 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:

$ 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:

$ blog publish [OPTIONS] NAME

Arguments:

  • NAME: Name of draft. [required]

Options:

  • --help: Show this message and exit.

blog unpublish

Unpublish a post.

Usage:

$ blog unpublish [OPTIONS] NAME

Arguments:

  • NAME: Name of post. [required]

Options:

  • --help: Show this message and exit.

blog init

Initialize the application interactively.

Usage:

$ blog init [OPTIONS]

Options:

  • --help: Show this message and exit.

blog rename

Rename a post or draft.

Usage:

$ 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 <root>.

Usage:

$ blog sync [OPTIONS]

Options:

  • --help: Show this message and exit.

blog config

Configuration Subcommands.

Usage:

$ 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:

$ blog config list [OPTIONS]

Options:

  • --help: Show this message and exit.

blog config set

Set a configuration.

Usage:

$ 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:

$ blog config reset [OPTIONS]

Options:

  • --help: Show this message and exit.

Metadata

Release files for jekyll-cli 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jekyll-cli 2.0.0
File Size Uploaded
jekyll_cli-2.0.0.tar.gz 23.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jekyll-cli 2.0.0
File Interpreter ABI Platform
jekyll_cli-2.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 43.1 kB

Release files / jekyll_cli-2.0.0.tar.gz

Download URL jekyll_cli-2.0.0.tar.gz
Size 23.9 kB
Tags Source
SHA-256 checksum
How to use checksums
134ecff34297f5e28b506c892d65210d088a74b9947f6b43febe8e0df10c3853
BLAKE2b-256 checksum
How to use checksums
bfd905b4e7d7ad32048a5d42597971e941e8f0ae8da6654150b8e9ed555eeed4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.14

Release files / jekyll_cli-2.0.0-py3-none-any.whl

Download URL jekyll_cli-2.0.0-py3-none-any.whl
Size 19.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8e61dc40b8ae8fdac3e01ae4fc3834e29993fddec110b758380313e52a7c7aae
BLAKE2b-256 checksum
How to use checksums
2545b100410e5723e61b6847a342dbe4c53b4eaf306ce6b684abef24f945de6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.14

Release history Release notifications | RSS feed

This release

2.0.0 This release

2 release files

1.2.1

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.4

2 release files

1.0.2

2 release files

1.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page