CLI / getting started
Install the ShipDocs CLI, authenticate, and upload a local working directory for documentation.
URL: https://shipdocs.sh/docs/cli
Markdown: https://shipdocs.sh/docs/cli.md
Install script: https://shipdocs.sh/install.sh
Install
curl -fsSL shipdocs.sh | sh
The installer downloads the platform binary. Equivalent: fetch https://shipdocs.sh/install.sh and run it.
Shell clients hitting https://shipdocs.sh/ with a curl/wget user-agent also receive the install script (Cloudflare middleware).
Authenticate
shipdocs login
Opens the browser, completes OAuth / magic-link sign-in, and stores a CLI token locally. Check identity:
shipdocs whoami
Sign out:
shipdocs logout
Ship a project (index from cwd)
From the root of your repository:
shipdocs ship
Optional project name:
shipdocs ship my-api
Behavior:
- Packs the current working directory (respects
.gitignore) - Uploads to ShipDocs
- Waits for the indexer to finish generating Overview + component docs
You can also import from the web app (GitHub / GitLab / ZIP) without the CLI: https://shipdocs.sh/
Other commands
| Command | Purpose |
|---|---|
shipdocs | Interactive TUI with slash commands |
shipdocs ship [name] | Pack cwd, upload, wait for docs |
shipdocs login | Browser auth; save CLI token |
shipdocs logout | Delete saved token |
shipdocs whoami | Show signed-in identity and org |
shipdocs list | List recent projects |
shipdocs update | Check for and install the latest CLI |
shipdocs help | Print usage |
Environment overrides
| Variable | Purpose |
|---|---|
SHIPDOCS_API | API base URL (default production API) |
SHIPDOCS_APP | Web app URL used for browser login |
SHIPDOCS_CONFIG | Directory for saved CLI config/token |
Web getting started (no CLI)
- Open https://shipdocs.sh/ and create an account (magic link or OAuth).
- Add a project — paste a repo URL or upload a ZIP.
- Wait for indexing; open Docs and Chat in the project UI.
- Optional: flip a project public and share via Showcase.