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.
  • --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.1.1.tar.gz (10.9 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.1-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jekyll_cli-1.1.1.tar.gz
  • Upload date:
  • Size: 10.9 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.1.tar.gz
Algorithm Hash digest
SHA256 ec6463b5b7d658ed065df9945a49f8c5eb09b9fb2bb6709753269da4075f88b0
MD5 27bb752c3839d6b48f77d8578c4b7c81
BLAKE2b-256 33243d1b8d7991098e3538f15c0abd1ebd2687824297d58a0d64826a97d5930e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jekyll_cli-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8ed14284be14a6b91673f7ea17e60624b9f04855faaa812052c3756e5f6eded
MD5 5ab3aba13d2de25092e1d695737f6991
BLAKE2b-256 a522e1f5628777a18c6c531e37f674021f8d444fb2dc830b06196748c1faaa12

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