---
title: CLI / getting started
description: Install the ShipDocs CLI, sign in, and ship a local project for indexing. Commands for login, ship, list, and update.
order: 2
---

# 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

```bash
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

```bash
shipdocs login
```

Opens the browser, completes OAuth / magic-link sign-in, and stores a CLI token locally. Check identity:

```bash
shipdocs whoami
```

Sign out:

```bash
shipdocs logout
```

## Ship a project (index from cwd)

From the root of your repository:

```bash
shipdocs ship
```

Optional project name:

```bash
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)

1. Open https://shipdocs.sh/ and create an account (magic link or OAuth).
2. Add a project — paste a repo URL or upload a ZIP.
3. Wait for indexing; open Docs and Chat in the project UI.
4. Optional: flip a project public and share via [Showcase](https://shipdocs.sh/showcase).

## Related

- [How ShipDocs works](https://shipdocs.sh/docs/how-it-works.md)
- [Security & encryption](https://shipdocs.sh/docs/security.md)
- [Pricing / homepage](https://shipdocs.sh/index.md)