Categories

A category groups articles in your knowledge base and can nest inside another category. For fields and response details, see the API reference. This command lists the category tree with article counts. The tree omits categories without published articles, and omits private categories for API keys. Pass --flat to list every category, including empty and private ones, as flat rows. Use this when you want a category ID to filter articles by, or to check where a new article should go before creating it.

neetokb categories list
neetokb categories list --page-size 100
neetokb categories list --flat

Flag	Type	Default	Description
`--flat`	`bool`	`false`	List every category, including empty and private ones, as flat rows with counts
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)

Sample output (--json)

{
  "data": [
    {
      "id": "b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a",
      "name": "Getting Started",
      "slug": "getting-started",
      "description": null,
      "parent_id": null,
      "depth": 0,
      "articles_count": 12,
      "categories_count": 2,
      "total_articles_count": 18,
      "url": "/categories/getting-started",
      "subcategories": [],
      "ancestors": []
    }
  ],
  "breadcrumbs": [
    {
      "label": "List articles in category",
      "command": "neetokb articles list --category-id <id>"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

subcategories nests the full child categories, and ancestors lists the parents up to the root. articles_count covers the category itself; total_articles_count includes its subcategories. With --flat, each row also carries is_private and has no subcategories or ancestors. Private categories are hidden from logged-out visitors only; members see every article.

Pass an id from this list to neetokb articles list --category-id. To place a new article, neetokb articles create --category takes category names, not these IDs.

Show a category

This command shows one category. articles_count counts published articles only.

neetokb categories show billing

Required arguments:

<id> - Category UUID or slug

Create a category

This command creates a category. Changing categories needs the Manage categories permission.

neetokb categories create --name Billing --description "Invoices" --parent getting-started --position 1

Flag	Type	Required	Default	Description
`--description`	`string`			Category description
`--name`	`string`	Yes		Category name (up to 120 characters)
`--parent`	`string`			Parent category ID or slug
`--position`	`int`		`0`	Position among sibling categories, starting at 1
`--private`	`bool`		`false`	Hide the category from visitors who are not signed in (—private=false makes it public)

--position is 1-based among the siblings. A number larger than the sibling count puts the category last. A public category cannot sit under a private parent.

Update a category

This command renames a category, changes its privacy, moves it or changes its position. Only the flags you pass change.

neetokb categories update billing --name "Billing and invoices"
neetokb categories update billing --parent ""

Required arguments:

<id> - Category UUID or slug

Flag	Type	Default	Description
`--description`	`string`		Category description
`--name`	`string`		Category name (up to 120 characters)
`--parent`	`string`		Parent category ID or slug
`--position`	`int`	`0`	Position among sibling categories, starting at 1
`--private`	`bool`	`false`	Hide the category from visitors who are not signed in (—private=false makes it public)

--parent "" moves the category to the top level. --private also applies to its subcategories.

Delete a category

This command deletes a category. Its articles and subcategories move to --move-to-category-id, or to the parent category when you leave it out.

neetokb categories delete billing --move-to-category-id getting-started

Required arguments:

<id> - Category UUID or slug

Flag	Type	Required	Default	Description
`--move-to-category-id`	`string`			Category ID or slug that receives the articles and subcategories

A top-level category that has articles or subcategories needs --move-to-category-id. The last remaining category cannot be deleted.

Reorder category articles

This command sets the order of the articles in a category. Articles you leave out follow in their current order.

neetokb categories reorder-articles billing --article-ids refund-policy,invoices

Required arguments:

<id> - Category UUID or slug

Flag	Type	Required	Default	Description
`--article-ids`	`string`	Yes		Article IDs, slugs or permalink identifiers in the wanted order (comma-separated)

Each article must be in the category. An article cannot be listed twice.

Getting started

Commands

Show a category

Create a category

Update a category

Delete a category

Reorder category articles

​List categories

​Show a category

​Create a category

​Update a category

​Delete a category

​Reorder category articles

List categories

Show a category

Create a category

Update a category

Delete a category

Reorder category articles