Workspace

A workspace is the NeetoKB organization behind your subdomain. For fields and response details, see the API reference and Update organization settings.

Show workspace information

This command shows your knowledge base’s name and public URL. Use this to confirm which workspace a command will act on before running it, especially when several are signed in.

neetokb workspace info
neetokb workspace info --subdomain acme

Sample output (--json)

{
  "data": {
    "knowledge_base_name": "Spinkart Help Center",
    "url": "https://spinkart.neetokb.com"
  }
}

To check authentication and connectivity rather than workspace settings, run neetokb doctor.

Update workspace settings

This command changes the knowledge base name, texts, sign-up, contact section and social sharing. Only the flags you pass change. It needs the Manage basic info permission. --social-sharing and --facebook-app-id need the Manage social sharing permission instead.

neetokb workspace update --name "Acme Help" --header-text "How can we help?"
neetokb workspace update --allow-signup=false --contact-title "Need more help?" --contact-button-label "Contact us"

Flag	Type	Default	Description
`--allow-signup`	`bool`	`false`	Let visitors sign up (—allow-signup=false turns it off)
`--contact-button-label`	`string`		Contact section button label
`--contact-kind`	`string`		Contact section button kind, such as action
`--contact-link`	`string`		Contact section button link
`--contact-title`	`string`		Contact section title
`--copyright`	`string`		Copyright text in the footer
`--facebook-app-id`	`string`		Facebook app ID (letters and digits)
`--header-text`	`string`		Home page heading
`--name`	`string`		Knowledge base name (up to 80 characters)
`--search-input-text`	`string`		Search box placeholder text
`--show-article-nav-links`	`bool`	`false`	Show previous and next links on articles
`--site-content-preference`	`string`		What the home page shows, such as Categories
`--social-sharing`	`bool`	`false`	Enable social media sharing

--name is up to 80 characters. --facebook-app-id takes letters and digits only. The contact section flags are merged into the current contact section. The command prints the updated settings.

Knowledge base SEO settings

These commands show and change the SEO settings of the whole knowledge base. Both need the Manage SEO settings permission. For one article, see neetokb articles seo.

neetokb workspace seo show

Update knowledge base SEO settings

Only the flags you pass change.

neetokb workspace seo update --title "Acme Help" --keywords help,support --allow-crawl

Flag	Type	Default	Description
`--allow-crawl`	`bool`	`false`	Let search engines crawl the knowledge base (—allow-crawl=false blocks them)
`--description`	`string`		Meta description
`--google-analytics-id`	`string`		Google Analytics tracking ID
`--keywords`	`string`		Keywords (comma-separated); replaces the current list
`--title`	`string`		Page title
`--title-suffix`	`string`		Text added after every page title

--keywords replaces the whole list. --allow-crawl=false blocks search engines.

Getting started

Commands

Show workspace information

Update workspace settings

Knowledge base SEO settings

Update knowledge base SEO settings

​Show workspace information

​Update workspace settings

​Knowledge base SEO settings

​Update knowledge base SEO settings

Show workspace information

Update workspace settings

Knowledge base SEO settings

Update knowledge base SEO settings