Smoothdev Documentation
Documentation for the Smoothdev CLI and API.
Overview
Smoothdev generates documentation artifacts from git data: commit messages, PR summaries, release notes, and repository documentation.
When to Use It
- Generate commit messages from staged changes
- Generate PR titles and summaries from GitHub PRs
- Generate release notes from git history
- Generate repository documentation from codebase analysis
How It Works
- Install the CLI via pip
- Authenticate with Smoothdev
- Run generation commands in git repositories
- Output to stdout or push to GitHub
Configuration
See CLI Configuration for setup options.
Output Behavior
| Artifact | Input | Output |
|---|---|---|
| Commit | Staged git changes | Conventional commit message |
| PR | GitHub PR data | Title and structured summary |
| Release | Git history between refs | Categorized changelog |
| Docs | Repository analysis | Markdown documentation |
Security and Data Handling
Smoothdev encrypts customer data in transit and at rest using tenant-scoped encryption keys. Source data is processed only for the requested operation and is not retained long term. Generated artifacts are returned to the user. Operational metrics and validation logs are retained to improve system reliability and quality.
Limitations
- Generation requests require authentication (JWT or API key)
- GitHub operations require a valid GitHub token
- Large diffs may be truncated
- Repository documentation requires read access
Troubleshooting
| Issue | Resolution |
|---|---|
| Authentication error | Run smooth auth login |
| GitHub token error | Set GITHUB_TOKEN environment variable |
| Generation timeout | Reduce diff size or use --skip-judging |
Documentation
| Section | Description |
|---|---|
| Getting Started | Installation and first request |
| Commit Messages | Commit artifact generation |
| Pull Requests | PR artifact generation |
| Release Notes | Release artifact generation |
| CLI Reference | Command reference |
| API Reference | REST and GraphQL API |