This folder is the product and usage guide for Gitfleet. It documents the CLI as users experience it: provider-neutral concepts first, provider differences where they matter, and command families by their public names.
Read these docs when you want to understand which command to use, what provider state it reads or changes, and how to run it safely in an interactive shell or automation. The installed CLI help remains the exact syntax reference for the current binary; these pages add product context, workflows, safety notes, and provider expectations.
- Concepts explains the product model and vocabulary.
- Authentication covers profiles, tokens, and hosts.
- Configuration lists supported configuration and environment variables.
- Providers describes GitHub and GitLab support.
- Output explains human output, JSON output, debug logs, and terminal themes.
- Safety documents confirmations,
--yes, and--dry-run. - Troubleshooting gives common fixes.
- Documentation Guide defines the user-first writing checklist for expanding these docs.
Use commands/ for every public command family. Each page answers what the command does, why it exists, when to use it, common examples, provider notes, safety behavior, and related commands.
Command pages are organized by product vocabulary, not Rust module names or
provider API names. For example, use change for pull requests and merge
requests, planning for milestones and projects, and registry for packages
and container images.
Use workflows/ for task-oriented guides:
- First Run
- Multi-provider Profiles
- Repository Lifecycle
- Change Review
- Pipeline Delivery
- Security Governance
- Workspace Fleets
- Automation and JSON
Workflow guides are the best place to start when the job spans multiple command families. They show a safe order of operations: inspect first, preview when possible, then mutate with confirmation.
Architecture Overview summarizes the crate boundaries and provider contract for readers who want implementation context. Detailed contributor rules remain in ../AGENTS.md.