Skip to main content

Jekyll Blog CLI Tool

Project description

Jekyll CLI

Jekyll Blog CLI Tool.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • build: Build jekyll site.
  • config: Configuration Subcommands.
  • 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:

$ blog build [OPTIONS]

Options:

  • --draft / --no-draft: Build including drafts. [default: no-draft]
  • --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.
  • reset: Reset default configuration.
  • set: Set a configuration.

blog config list

List all configurations.

Usage:

$ blog config list [OPTIONS]

Options:

  • --help: Show this message and exit.

blog config reset

Reset default configuration.

Usage:

$ blog config reset [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 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.
  • --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 init

Initialize the application interactively.

Usage:

$ blog init [OPTIONS]

Options:

  • --help: Show this message and exit.

blog list

List all posts and drafts or find items by name.

Usage:

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

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

$ 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.
  • --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 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 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 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 unpublish

Unpublish a post.

Usage:

$ blog unpublish [OPTIONS] NAME

Arguments:

  • NAME: Name of post. [required]

Options:

  • --help: Show this message and exit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jekyll_cli-1.0.9.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jekyll_cli-1.0.9-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file jekyll_cli-1.0.9.tar.gz.

File metadata

  • Download URL: jekyll_cli-1.0.9.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Windows/11

File hashes

Hashes for jekyll_cli-1.0.9.tar.gz
Algorithm Hash digest
SHA256 c27d76f7577a3bb4d961e3c210d6f1a87a61c408816903d265c26ce4b7479f53
MD5 0a9d4d5c06ac8aac1c4a218792103c16
BLAKE2b-256 845c58a6df2108eae51cffabac28a0658bbc34d75af3190468d76da2defe3318

See more details on using hashes here.

File details

Details for the file jekyll_cli-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: jekyll_cli-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Windows/11

File hashes

Hashes for jekyll_cli-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 939e9994c9a73d0a64562fe9238ce1eb020815a2af9fb06287ef9a5f6261e87c
MD5 911d6e3e795864347e7daf6490ea99eb
BLAKE2b-256 3248e802d9b9a87e6e93dd81a68d6c4ab5d33f5d3e90080166a4c588f084da23

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page