# CLI Reference CLI Reference ## Global Options | Option | Description | |--------|-------------| | `-p, --profile ` | Profile name to use (uses default if not specified) | --- ## Profiles Manage authentication profiles. ### `profiles add` Add a new profile with URL and API tokens. ```bash bookstack profiles add --name mywiki --url https://wiki.example.com \ --token-id --token-secret ``` | Option | Description | Environment Variable | |--------|-------------|---------------------| | `--name ` | Profile name | — | | `--url ` | BookStack instance URL | `BOOKSTACK_URL` | | `--token-id ` | API Token ID | `BOOKSTACK_TOKEN_ID` | | `--token-secret ` | API Token Secret | `BOOKSTACK_TOKEN_SECRET` | ### `profiles list` List all configured profiles. ```bash bookstack profiles list ``` ### `profiles delete` Delete a profile by name. ```bash bookstack profiles delete --name mywiki ``` --- ## Books ### `list-books` List all books, optionally filtered by shelf. ```bash bookstack list-books [--shelf-id ] [--count ] ``` | Option | Description | |--------|-------------| | `--shelf-id ` | Filter by shelf ID | | `--count ` | Max results (default: 20) | ### `get-book` Get details of a single book. ```bash bookstack get-book ``` ### `create-book` Create a new book. ```bash bookstack create-book [DESCRIPTION] ``` ### `update-book` Update an existing book. ```bash bookstack update-book [--name ] [--description ] ``` ### `delete-book` Delete a book. ```bash bookstack delete-book ``` --- ## Chapters ### `list-chapters` List all chapters, optionally filtered by book. ```bash bookstack list-chapters [--book-id ] [--count ] ``` | Option | Description | |--------|-------------| | `--book-id ` | Filter by book ID | | `--count ` | Max results (default: 20) | ### `get-chapter` Get details of a single chapter. ```bash bookstack get-chapter ``` ### `create-chapter` Create a new chapter in a book. ```bash bookstack create-chapter --book-id --name [--description ] ``` ### `update-chapter` Update an existing chapter. ```bash bookstack update-chapter [--name ] [--description ] [--book-id ] ``` ### `delete-chapter` Delete a chapter. ```bash bookstack delete-chapter ``` --- ## Pages ### `list-pages` List all pages, optionally filtered by book or chapter. ```bash bookstack list-pages [--book-id ] [--chapter-id ] [--count ] ``` | Option | Description | |--------|-------------| | `--book-id ` | Filter by book ID | | `--chapter-id ` | Filter by chapter ID (includes sub-chapters) | | `--count ` | Max results (default: 20) | ### `get-page` Get a page with optional content display. ```bash bookstack get-page [--content|--markdown] ``` | Option | Description | |--------|-------------| | `--content` | Show full HTML content | | `--markdown` | Show markdown content | ### `create-page` Create a new page in a book or chapter. ```bash bookstack create-page --name \ [--book-id ] [--chapter-id ] \ [--html ] [--markdown ] [--content ] ``` At least one of `--book-id` or `--chapter-id` is required. At least one of `--html`, `--markdown`, or `--content` is required. ### `update-page` Update an existing page. ```bash bookstack update-page \ [--name ] [--html ] [--markdown ] [--content ] \ [--book-id ] [--chapter-id ] ``` ### `delete-page` Delete a page. ```bash bookstack delete-page ``` --- ## Shelves ### `list-shelves` List all shelves. ```bash bookstack list-shelves [--count ] ``` ### `get-shelf` Get details of a single shelf. ```bash bookstack get-shelf ``` ### `create-shelf` Create a new shelf. ```bash bookstack create-shelf [DESCRIPTION] ``` --- ## Search Search across all content types. ```bash bookstack search [--type ] [--count ] ``` | Option | Description | |--------|-------------| | `--type ` | Filter by type: `page`, `chapter`, `book`, `bookshelf` | | `--count ` | Max results (default: 20) | ### Examples ```bash # Search all content for "rust" bookstack search "rust" # Search only pages bookstack search "rust" --type page # Search with limit bookstack search "configuration" --count 5 ```