How can we help?

Articles commands

The articles command lets you list, show, create, and update help articles in your NeetoKB workspace.

List articles

This command shows articles in your workspace. Use this when you want to inspect titles, slugs, states, and category placement before opening the admin editor.

neetokb articles list
neetokb articles list --page 1 --page-size 3 --state published

Optional flags:

  • --category-id - Filter by category ID

  • --order-by - Sort order (ASC/DESC)

  • --page - Page number

  • --page-size - Items per page

  • --search-term - Search term

  • --sort-by - Sort field

  • --state - Filter by state (draft/published)

  • --subdomain <name> - Target a specific logged-in workspace

  • --json - Return JSON envelope output

  • --quiet - Return raw payload only

  • --toon - Return TOON (token-optimized) output

Sample output:

TITLE      SLUG       ID                                  IS ARCH...   STATE      UNIQUE VIEWS ...
────────   ────────   ─────────────────────────────────   ──────────   ────────   ────────────────
Ruby        ruby     b75938df-a8e7-4605-9e72-2747f8...     No           publi...   11              
Type...     type...   e00e2c18-8cda-4a87-9357-20d0a3...    No           publi...   10              
Kube...     kube...   5f6d4ff3-f76a-4ef1-9d1c-fac337...    No           publi...   10              

Page 1 of 5 (13 total records)

  Show: neetokb articles show <id>
  Update: neetokb articles update <id>

By default, list returns published articles. Use --state draft to include drafts.

Show an article

This command shows details for one article ID. Use this when you want to inspect HTML content, metadata, category, author, and permalink after finding the ID from articles list or search.

neetokb articles show b75938df-a8e7-4605-9e72-2747f8338555

Required argument:

  • <id> - Article UUID, slug, or permalink identifier

Optional flags:

  • --subdomain <name> - Target a specific logged-in workspace

  • --json - Return JSON envelope output

  • --quiet - Return raw payload only

  • --toon - Return TOON (token-optimized) output

Sample output:

ARTICLE  (22 fields)
  META     (4 fields)

Create an article

This command creates a new article. Use this when you want to publish or draft content from a script, CI job, or AI workflow.

neetokb articles create --title 'Getting started' --slug getting-started --category 'Help,Setup' --state draft --html-content '<p>Welcome.</p>'

Required flags:

  • --category - Category path (comma-separated, e.g. Parent,Child)

Optional flags:

  • --html-content - Article HTML content

  • --slug - Article slug

  • --state - Article state (draft/published)

  • --title - Article title

  • --subdomain <name> - Target a specific logged-in workspace

  • --json - Return JSON envelope output

  • --quiet - Return raw payload only

  • --toon - Return TOON (token-optimized) output

Sample output:

ID         98a234c3-9b9a-4747-b7f4-80ace8e16556
  SLUG       cli-doc-test-article
  PERMALINK  https://acme.neetokb.com/p/a-fadb829b

  Show: neetokb articles show <id>

Update an article

This command updates an existing article. Use this when you need to change title, slug, HTML body, or publish state without opening the article editor.

neetokb articles update 98a234c3-9b9a-4747-b7f4-80ace8e16556 --title 'Updated title' --state published

Required argument:

  • <id> - Article UUID, slug, or permalink identifier

Optional flags:

  • --html-content - Article HTML content

  • --slug - Article slug

  • --state - Article state (draft/published)

  • --title - Article title

  • --subdomain <name> - Target a specific logged-in workspace

  • --json - Return JSON envelope output

  • --quiet - Return raw payload only

  • --toon - Return TOON (token-optimized) output

Sample output:

ID         98a234c3-9b9a-4747-b7f4-80ace8e16556
  SLUG       cli-doc-test-article
  TITLE      -
  STATE      draft
  PERMALINK  https://acme.neetokb.com/p/a-fadb829b

For draft articles, include --state draft when updating title or HTML.