Get Started

Theneo CLI

The Theneo CLI creates, manages, and publishes docs from your terminal — everything in the dashboard, scripted.

Install

Bash

   npm install -g @theneo/cli@latest

This installs the CLI globally so you can run theneo from any directory.

Basic usage

Get a list of available commands and options:

Bash

   theneo help

General options

-V, --version — output the CLI version number.
-h, --help — display help for a command.

Primary commands

login — log into the Theneo CLI.
project — run project-related commands.
workspace — run workspace-related commands.
version — run project-version commands.
help [command] — get help for a specific command.

In this guide

Common Commands

Log in, create and update projects, publish, manage versions, and more, with copy-paste examples.

CLI Export

Export a project as Markdown or an OpenAPI spec from the command line.

Docs-as-Code with Markdown

Create and update projects from Markdown files on disk, and target specific project tabs.

Two-way Git sync

Wire the CLI into GitHub or GitLab to keep your repo and Theneo in sync automatically.

Best practices

Check your installed version with theneo -V to ensure compatibility.
Use --help regularly to understand each command’s requirements.
Keep the CLI updated for the latest features and fixes.
Ensure your API specs are correctly formatted before importing to avoid errors.

On this page

Theneo CLI