SaaS quickstart

1. 1

   Create an account

   Sign up at /signup using GitHub OAuth or email and password.
2. 2

   Connect your repository

   Install the Pith GitHub App on your organisation or personal account, or add a GitLab Personal Access Token. Pith syncs your accessible repositories automatically.
3. 3

   Configure doc types

   Choose which docs Pith maintains (README, API reference, architecture, changelog), set output paths, and pick templates.
4. 4

   Open a pull request

   Merge a PR into your watch branch. Pith will receive the webhook, analyse the diff, and open a documentation PR within minutes.

CLI quickstart

1. 1

   Install the CLI

   Run npm install -g pith to install globally.
2. 2

   Initialize your repo

   Run cd your-repo && pith init to scaffold a .pith.yml config and install git hooks.
3. 3

   Set your API key

   Export your Anthropic key: export ANTHROPIC_API_KEY=sk-ant-...
4. 4

   Generate docs

   Run pith update to read recent git changes and update your documentation.