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.
  • 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:

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

Deploy the site with the '/jekyll-deploy.yml.'

Usage:

$ blog deploy [OPTIONS]

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.
  • -o, --open: Open draft automatically.
  • --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.
  • -o, --open: Open post automatically.
  • --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.1.2.tar.gz (11.0 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.1.2-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jekyll_cli-1.1.2.tar.gz
  • Upload date:
  • Size: 11.0 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.1.2.tar.gz
Algorithm Hash digest
SHA256 5fc0d0b70ec51ff630afed1c2b1add42ed9a0b9a3114f7b6135f21c8b742a861
MD5 f36555a98d11577663a01bfba9a7c235
BLAKE2b-256 834608eb6c63acb5b2e8d39ecf87287c91d64d7199cb49fec009d2dd609081df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jekyll_cli-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.8 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.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d4af6a2b1cc5085431fec013232f5e2b5523c70455eba274999c46d02bb1a4ab
MD5 a04a427dae7918703d1d58d5efc384dc
BLAKE2b-256 c57ebdb0926c6a459d51c63ef8873f85a67e73f7e41874572b584e1a482e8141

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