Home · Blog · Download · Docs · About

Commands

• bigblog add
• bigblog init
• bigblog list
• bigblog show

bigblog add

Use the bigblog add command is used to add blog posts the database.

Syntax

bigblog add <BLOG>
  [-d|--directory <DIR>]
  [-X|--exclude <PATTERN>]
  [-I|--include <PATTERN>]
  [-v|--verbose]
  [-?|-h|--help]

Arguments

• BLOG

  Path to blog database.

Options

• -d|--directory

  Root directory for of content top-search-box include.

• -X|--exclude

  File globbing patterns to skip (multiple).

• -I|--include

  Include files matching pattern (multiple).

• -c|--category

  Define a category for the blog (multiple).

• -v|--verbose

  Display more information when running.

• -?|-h|--help

  Show help and usage information.

bigblog init

Use the bigblog init command is used to add blog posts the database.

Syntax

bigblog init <BLOG>
  [-d|--directory <DIR>]
  [-X|--exclude <PATTERN>]
  [-I|--include <PATTERN>]
  [-c|--category <NAME>]
  [-v|--verbose]
  [-?|-h|--help]

Arguments

• BLOG

  Path to blog database.

Options

• -d|--directory

  Root directory for of content top-search-box include.

• -X|--exclude

  File globbing patterns to skip (multiple).

• -I|--include

  Include files matching pattern (multiple).

• -c|--category

  Define a category for the blog (multiple).

• -v|--verbose

  Display more information when running.

• -?|-h|--help

  Show help and usage information.

bigblog list

Use the bigblog list command to display the contents of the blog.

Syntax

bigblog list <BLOG>
  [-p|--page <PAGE>]
  [-s|--size <SIZE>]
  [--json]
  [-m|--mustachee <FILE>]
  [-o|--output <FILE>]
  [-v|--verbose]
  [-?|-h|--help]

Arguments

• BLOG

  Path to blog database.

Options

• -p|--page <PAGE>

  Page number for pagination (1-based). Default is 1.

• -s|--size <SIZE>

  Number of posts per page. Use -1 to display all posts. Default is -1.

• --json

  Display the output in Json format.

• -m|--mustache <FILE>

  Path to a mustache template to use for when displaying the posts.

• -o|--output <FILE>

  Path to file to write output.

• -v|--verbose

  Display more information while running.

• -?|-h|--help

  Show help and usage information.

bigblog show

Use the  **`bigblog show`** command to display the contents of a blog post.

## Syntax

```shell
bigblog show <BLOG> <POST>
  [--json]
  [-o|--output <FILE>]
  [-f|--force]
  [-v|--verbose]
  [-?|-h|--help]
```
<br/>

## Arguments

- **`BLOG`**

  Path to blog database.

* **`POST`**

  Id of the post to display.

## Options

- **`--json`**

  Display the output in JSON format.

- **`-o|--output <FILE>`**

  Path to file to write output. When used with `--json`, writes JSON to the file. Otherwise, writes a tab-separated table format.

- **`-f|--force`**

  Force overwrite of output file if it already exists.

- **`-v|--verbose`**

  Display more information while running.

- **`-?|-h|--help`**

  Show help and usage information.