@falconer/cli

Command-line interface for Falconer.

What's New in 0.1.12

• Adds falconer ask for asking the Falconer agent a natural-language question and getting a synthesized, cited answer (parity with the ask_falcon MCP tool).
• Adds falconer metadata for updating a document's auto-update settings and type (parity with the update_document_metadata MCP tool).

What's New in 0.1.11

• Matches the Falconer Public API 0.1.11 schema.
• Adds falconer doc-status set for setting a document's review-workflow status (draft, in_review, approved, outdated).
• Adds falconer reviewers commands (list, add, remove, clear) for managing document reviewers.
• Hardens falconer content and falconer edit commands against malformed input.

What's New in 0.1.10

• Matches the Falconer Public API 0.1.10 schema.
• Adds falconer comments create for creating anchored document comments.

What's New in 0.1.9

• Matches the Falconer Public API 0.1.9 schema.
• Adds falconer revisions commands for document revision history.

What's New in 0.1.8

• Matches the Falconer Public API 0.1.8 schema.
• Adds full direct-child folder reordering with falconer folder reorder.
• Forwards parentDocumentId for document create, move, and publish commands.
• Adds comment unresolve support with falconer comments unresolve.

What's New in 0.1.7

• Matches the Falconer Public API 0.1.7 schema.
• Adds targeted content replace/insert/delete commands.
• Adds comment list/reply/update/delete/resolve commands.
• Adds media upload support for images and videos.
• Adds navigation read/write commands for children, trees, moves, and publishing docs.
• Adds folder create/get/update/delete commands.
• Adds document permission updates from JSON.

Setup

npm install -g @falconer/cli
falconer oauth login

Document Commands

| Command | Description | |---------|-------------| | falconer read <identifier> | Fetch a document by ID, slug, title, or URL | | falconer search <query> | Search for documents | | falconer ask <question> [--conversation-id <id>] [--json] | Ask the Falconer agent for a synthesized, cited answer | | falconer create [-f <file>] [--parent-folder-id <id>\|--parent-document-id <id>] | Create a document from stdin or a file | | falconer edit <identifier> --old "text" --new "replacement" [--replace-all] | Find-and-replace edit on a document | | falconer content replace <identifier> --old "text" --new "replacement" | Replace exact Markdown text in a document | | falconer content insert <identifier> (--before <anchor>\|--after <anchor>\|--start\|--end) [-f <file>] | Insert Markdown content in a document | | falconer content delete <identifier> --old "text" | Delete exact Markdown text from a document | | falconer overwrite <id> [-f <file>] | Replace a document's full content from stdin or a file | | falconer upload <file> [--kind auto\|image\|video] [--alt "text"] [--json] | Upload image/video media and print a snippet | | falconer delete <id> | Delete a document by archiving it |

Revision Commands

| Command | Description | |---------|-------------| | falconer revisions list <doc-id> [--limit <n>] [--cursor <cursor>] [--json] | List document revisions | | falconer revisions read <doc-id> <revision-id> [--json] | Read a revision's Markdown content | | falconer revisions create <doc-id> [--json] | Create a revision of current content | | falconer revisions restore <doc-id> <revision-id> [--json] | Restore a document to a revision | | falconer revisions delete <doc-id> <revision-id> [--json] | Delete a single document revision |

Comment Commands

| Command | Description | |---------|-------------| | falconer comments list <doc-id> [--status active\|resolved\|all] [--json] | List document comment threads | | falconer comments create <doc-id> --anchor <text> [-f <file>\|--content <text>] | Create a document comment | | falconer comments reply <doc-id> <comment-id> [-f <file>] | Reply to a document comment | | falconer comments update <doc-id> <comment-id> [-f <file>] | Update a document comment | | falconer comments delete <doc-id> <comment-id> | Delete a document comment | | falconer comments resolve <doc-id> <comment-id> | Resolve a document comment | | falconer comments unresolve <doc-id> <comment-id> | Unresolve a document comment |

Navigation Commands

| Command | Description | |---------|-------------| | falconer nav children [--section company\|private] [--parent-folder-id <id>] [--limit <n>] [--cursor <cursor>] [--json] | List visible child folders and documents | | falconer nav tree [--section company\|private] [--parent-folder-id <id>] [--depth <n>] [--max-nodes <n>] [--json] | Print a visible navigation tree | | falconer nav move <nav-item-id> [--section company\|private] [--parent-folder-id <id>\|--parent-document-id <id>\|--root] [--json] | Move a folder or document nav item | | falconer nav move-doc <doc-id> [--source-nav-item-id <id>] [--section company\|private] [--parent-folder-id <id>\|--parent-document-id <id>\|--root] [--json] | Move a document by document ID | | falconer nav publish-doc <doc-id> (--parent-folder-id <id>\|--parent-document-id <id>\|--root) [--source-nav-item-id <id>] [--json] | Publish a private document into company nav | | falconer folder get <folder-id> [--json] | Fetch folder metadata and visible children | | falconer folder create <title> [--description <text>] [--section company\|private] [--parent-folder-id <id>] [--json] | Create a folder | | falconer folder update <folder-id> [--title <title>] [--description <text>\|--clear-description] [--json] | Update folder metadata | | falconer folder reorder <folder-id> <nav-item-id>... [--json] | Set the full direct-child order for a folder | | falconer folder delete <folder-id> [--json] | Delete a folder by archiving it and its contents |

Permission Commands

| Command | Description | |---------|-------------| | falconer permissions update <doc-id> [-f <json-file>] [--json] | Update document permissions from JSON |

Metadata Commands

| Command | Description | |---------|-------------| | falconer metadata <doc-id> [--auto-update <on\|off>] [--update-mode <auto_apply\|draft_approval>] [--document-type <skill\|none>] [--json] | Update a document's auto-update settings and type |

OAuth Commands

| Command | Description | |---------|-------------| | falconer oauth login | Sign in with Falconer OAuth | | falconer oauth logout | Revoke the stored OAuth session | | falconer oauth status | Show the current OAuth session | | falconer oauth org list | List organizations available to the OAuth session | | falconer oauth org set <org-id-or-name> | Set the active organization for API requests |

Config Commands

| Command | Description | |---------|-------------| | falconer config help | Show config command help | | falconer config get base-url | Print the effective Falconer API base URL | | falconer config set base-url <url> | Save a Falconer base URL | | falconer config unset base-url | Remove the saved Falconer base URL | | falconer config path | Print the config file path |