@changesmith/cli 1.4.0

package/README.md

@@ -0,0 +1,206 @@
+# @changesmith/cli
+
+Generate beautiful, AI-powered changelogs from your git history.
+
+The Changesmith CLI connects to [changesmith.dev](https://changesmith.dev) to generate professional changelogs from your commits. Prompt logic stays server-side; the CLI handles local git operations and API communication.
+
+## Installation
+
+```bash
+npm install -g @changesmith/cli
+# or
+pnpm add -g @changesmith/cli
+# or
+npx @changesmith/cli
+```
+
+## Quick Start
+
+```bash
+# Initialize in your repository
+changesmith init
+
+# Log in to Changesmith
+changesmith login
+
+# Generate a changelog for your latest tag
+changesmith generate
+```
+
+## Commands
+
+### `changesmith init`
+
+Initialize Changesmith in the current repository. Creates a `.changesmith.json` config file.
+
+```bash
+changesmith init
+changesmith init --force  # Overwrite existing config
+```
+
+### `changesmith login`
+
+Authenticate with Changesmith. Uses device authorization flow by default.
+
+```bash
+changesmith login
+
+# For CI/automation, use a pre-generated token
+changesmith login --token YOUR_TOKEN
+```
+
+### `changesmith logout`
+
+Log out from Changesmith.
+
+```bash
+changesmith logout
+```
+
+### `changesmith generate`
+
+Generate a changelog from git commits.
+
+```bash
+# Generate for latest tag
+changesmith generate
+
+# Generate for a specific version
+changesmith generate v1.2.0
+
+# Specify a range
+changesmith generate v1.2.0 --from v1.1.0
+
+# Output to file
+changesmith generate v1.2.0 -o CHANGELOG.md
+```
+
+**Options:**
+
+- `--from <tag>` — Starting tag/commit (defaults to previous tag)
+- `--to <ref>` — Ending ref (defaults to the version tag)
+- `-o, --output <file>` — Output file (defaults to stdout)
+
+### `changesmith status`
+
+Show Changesmith status for the current repository.
+
+```bash
+changesmith status
+```
+
+Displays:
+
+- Git repository info (tags, current state)
+- Project config status
+- Authentication status
+- Current plan info
+
+### `changesmith config`
+
+View or modify configuration.
+
+```bash
+# Show all config
+changesmith config show
+
+# Show project config only
+changesmith config show --project
+
+# Show user config only
+changesmith config show --user
+
+# Get a specific value (project config)
+changesmith config get excludeTypes
+
+# Get a specific value (user config)
+changesmith config get apiUrl --global
+
+# Set a value (project config)
+changesmith config set excludeTypes "chore,style,ci,docs"
+changesmith config set defaultBranch main
+
+# Set a value (user config)
+changesmith config set apiUrl https://api.changesmith.dev --global
+
+# Reset project config to defaults
+changesmith config reset --force
+```
+
+## Configuration
+
+### Project Config (`.changesmith.json`)
+
+Repository-specific settings stored in your project root:
+
+```json
+{
+  "version": 1,
+  "defaultBranch": "main",
+  "excludeTypes": ["chore", "style", "ci"],
+  "includeScopes": [],
+  "excludeScopes": [],
+  "styleGuide": "",
+  "customPrompt": ""
+}
+```
+
+| Key             | Description                                   |
+| --------------- | --------------------------------------------- |
+| `version`       | Config version (always `1`)                   |
+| `defaultBranch` | Default branch for comparisons                |
+| `excludeTypes`  | Commit types to exclude (e.g., `chore`, `ci`) |
+| `includeScopes` | Only include these scopes (empty = all)       |
+| `excludeScopes` | Exclude these scopes                          |
+| `styleGuide`    | Style guide name for generation               |
+| `customPrompt`  | Custom instructions for AI generation         |
+
+### User Config
+
+Global settings stored in `~/.changesmith`:
+
+| Key      | Description                                           |
+| -------- | ----------------------------------------------------- |
+| `apiUrl` | API endpoint (default: `https://api.changesmith.dev`) |
+| `token`  | Auth token (set via `changesmith login`)              |
+
+### Environment Variables
+
+Environment variables take precedence over stored configuration, making CI/CD usage simpler. Empty or whitespace-only values are ignored, falling back to stored config.
+
+| Variable              | Description                             |
+| --------------------- | --------------------------------------- |
+| `CHANGESMITH_TOKEN`   | Auth token (no `login` needed when set) |
+| `CHANGESMITH_API_URL` | API endpoint override                   |
+
+> **Security:** Never commit tokens to version control. Use your CI platform's secrets management (e.g., GitHub Secrets, GitLab CI/CD variables).
+
+## CI/CD Usage
+
+For automated workflows, set `CHANGESMITH_TOKEN` as an environment variable. No `login` step is required:
+
+```yaml
+# GitHub Actions example
+- name: Generate Changelog
+  env:
+    CHANGESMITH_TOKEN: ${{ secrets.CHANGESMITH_TOKEN }}
+  run: npx @changesmith/cli generate ${{ github.ref_name }} -o CHANGELOG.md
+```
+
+Generate an API token from the [Changesmith dashboard](https://changesmith.dev/dashboard/settings).
+
+## Requirements
+
+- Node.js 20+
+- Git repository with a GitHub remote
+- Repository connected to Changesmith (via GitHub App)
+
+## Links
+
+- [Changesmith Dashboard](https://changesmith.dev/dashboard)
+- [Documentation](https://changesmith.dev/docs)
+- [GitHub](https://github.com/PhilipLudington/Changesmith)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }