You are viewing the v1.0.0 documentation.

CLI Overview

The Specra CLI lets you create, deploy, and manage your documentation sites from the terminal

CLI Overview

The Specra CLI provides two commands that work together:

  • create-specra — Scaffold new projects and manage your docs (all-in-one)
  • specra — Management-focused CLI for deploy, auth, and diagnostics

Both commands share the same subcommands. Use whichever you prefer.

Installation

Install globally to use specra and create-specra anywhere:

Or run without installing using npx:

Code
bash
1npx create-specra@latest

Commands

CommandDescription
create-specra init [dir]Create a new Specra documentation site
create-specra loginAuthenticate with your Specra account
create-specra logoutClear stored credentials
create-specra deployDeploy your docs to Specra Cloud
create-specra projectsList your projects
create-specra logs <projectId>View deployment logs
create-specra doctorValidate your specra.config.json
create-specra helpShow help for all commands
Info
All commands also work with `specra` instead of `create-specra`. For example, `specra login` is the same as `create-specra login`.

Quick Start

Create a new project

Code
bash
1npx create-specra@latest my-docs

Authenticate

Code
bash
1cd my-docs
2npx create-specra login

This opens your browser to authenticate. Your token is saved to the local specra.config.json so each project can use a different account.

Deploy

Code
bash
1npx create-specra deploy

Your docs are packaged and uploaded to Specra Cloud.

Getting Help

Every command supports --help:

Code
bash
1create-specra --help # Show all commands
2create-specra login --help # Show login options
3create-specra deploy --help # Show deploy options

Next Steps