Skip to main content

Repositories

CLI equivalents of Admin Tasks → Repositories. All commands are admin-only, same as the Repositories tab.

List Repositories​

sudodocs admin integrations list

Add a Git Repository​

sudodocs admin integrations create \
  --name "Main API Docs" \
  --base-url "https://github.com/org/repo.git" \
  --repo-type documentation \
  --auth-type pat \
  --service-pat "github_pat_xxxxxxxxxxxxxxxxxxxx"

Already signed in to the GitHub CLI? Use its token instead of pasting one:

sudodocs admin integrations create --name "Main API Docs" \
  --base-url "https://github.com/org/repo.git" --repo-type documentation --from-gh
OptionRequiredDescription
--nameYesA recognizable name, e.g. "Main API Docs".
--base-urlYesThe HTTPS clone URL.
--repo-typeYesdocumentation, code (Pro/Enterprise only), or web.
--auth-typeRequired unless --repo-type webpat or app.
--service-patFor --auth-type patA GitHub token: fine-grained (github_pat_, with Contents and Pull requests read & write), classic (ghp_, with repo scope), or GitHub CLI (gho_).
--from-ghNoUse the output of gh auth token as the token (implies --auth-type pat). It's tied to your personal gh login and stops working after gh auth logout.
--accept-insufficientNoSave a valid token even if it lacks write access to the repository.
--app-id, --installation-id, --private-keyFor --auth-type app (Enterprise only)GitHub App credentials.

Add a Public Website​

sudodocs admin integrations create \
  --name "Public Docs Site" \
  --base-url "https://docs.example.com" \
  --repo-type web

SudoDocs automatically looks for an /llms.txt file or a sitemap.xml to discover pages - same as the web form, no --auth-type needed.

Sync a Repository (RAG)​

sudodocs sync --integration-id 42

This is the exact same action as clicking Sync on the Repositories tab. The command blocks until the sync completes or fails, then prints what it read and what it cost, for example Synced 7 changed files (1 credit). - see What a Sync Costs.

Find --integration-id via sudodocs admin integrations list.

See a Docs Repository's Layout​

sudodocs admin integrations docs-profile 3
sudodocs admin integrations docs-profile 3 --image-dir static/img/screens
sudodocs admin integrations docs-profile 3 --use-detected

Shows what SudoDocs learned about a documentation repository when it synced: the docs framework, where images live, how pages reference them and how files are named. --image-dir makes Docflows save screenshots in another folder; --use-detected goes back to the detected one. --json prints everything. Admin-only. CLI equivalent of What SudoDocs Learns About a Docs Repository. API: GET or POST /api/v1/admin/integrations/<id>/docs-profile with {"image_dir": "..."}.

Cancel a Running Sync​

sudodocs admin jobs cancel <job_id>

Same as clicking the Stop Sync button that appears next to an in-progress sync's progress bar on the dashboard. The job ID is printed by sudodocs sync while it's running (Waiting for SudoDocs worker (Job: ...)).

Keep in Sync and Docs Branch​

sudodocs admin integrations keep-in-sync 42 --mode on-change
sudodocs admin integrations keep-in-sync 42 --mode schedule --every 168
sudodocs admin integrations keep-in-sync 42 --mode manual
sudodocs admin integrations keep-in-sync 42 --docs-branch develop
sudodocs admin integrations keep-in-sync 42 --default-branch

Sets when SudoDocs re-reads a repository (on-change, schedule every --every hours, default 24, or manual) and, for a documentation repository, the branch it reads, checks and opens pull requests into. See Keep in Sync and Docs Branch. sudodocs admin integrations list shows each repository's sync status and setting. The older sudodocs admin integrations sync-schedule 42 --hours 24 still works: with --hours it sets a schedule, without it Only when I click Sync.

API: POST /api/v1/admin/integrations/<id>/keep-in-sync with sync_mode (on_change, schedule, manual), sync_frequency_hours and docs_branch ("" for the default branch). GET /api/v1/admin/integrations includes a sync summary for each repository; GET /api/v1/admin/status includes each repository's sync state.

SudoDocs checks the token with GitHub before saving and prints its type, account, and expiry, plus a warning if access is missing - see Add a Git Repository with a Token.

The one-click Connect with GitHub flow needs a browser - use the dashboard for it.

Check a Token Without Saving It​

sudodocs admin integrations verify-token --token "github_pat_..." --repo-url "https://github.com/org/repo.git"
sudodocs admin integrations verify-token --from-gh

Prints the token's type, the GitHub account it belongs to, its expiry, and whether it can access the repository.

Update an Integration's Token​

sudodocs admin integrations update-token 42 --new-pat "github_pat_yyyyyyyyyyyyyyyyyyyy"
sudodocs admin integrations update-token 42 --from-gh

The new token is checked with GitHub first. Add --accept-insufficient to save a valid token that lacks write access.

Note: --from-gh, --accept-insufficient, and verify-token need sudodocs-cli 1.1.0 or later. Upgrade with pip install --upgrade sudodocs-cli.

Delete a Repository​

sudodocs admin integrations delete 42

Looking for webhook credentials or Screenshot Settings? Those are covered in Docflows, matching where Configure Webhooks and Screenshot Settings for Docflows puts them on the dashboard.