Docs Site Playground

Installation

Last updated

On this page

Install the command-line tool and check it works. This page tests code blocks in several languages, each with a copy button, and all five callout kinds.

Requirements#

ToolMinimum versionCheck with
Node24.0node --version
npm11.0npm --version
Git2.40git --version

Install the CLI#

Install it globally with npm:

Shell
npm install --global @acme/docs-cli
acme --version

Or on Windows, in PowerShell:

PowerShell
npm install --global @acme/docs-cli
Get-Command acme | Select-Object -ExpandProperty Source

Sign in#

Shell
acme login --workspace my-team

Note

The login opens your browser. If it can't, the CLI prints a link to open by hand.

Tip

Run acme doctor at any time to check your setup.

Important

You need the Publish docs sites permission to publish. Ask a workspace admin if you don't have it.

Warning

Signing in on a shared computer leaves a token in your home folder. Run acme logout when you're done.

Caution

Never commit .acme/credentials.json to Git. It grants full access to your workspace.

Verify#

TypeScript
import { createClient } from "@acme/docs-cli";

const client = createClient({ workspace: "my-team" });
const sites = await client.sites.list();
console.log(`You can publish ${sites.length} site(s).`);

Next: Configuration.