Skip to content
Back to search

autoship

CLI tool to automate changeset-based releases

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/vercel-labs--autoship/badge.svg)](/listings/vercel-labs--autoship)

HTML

<a href="/listings/vercel-labs--autoship"><img src="/api/listings/vercel-labs--autoship/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

1. Authenticate GitHub CLI

gh auth login

2. Set your API key

export AI_GATEWAY_API_KEY=your-key

3. Add a repository

npx autoship add myproject

You'll be prompted for: - GitHub owner (org or username) - Repository name - Base branch (default: `main`)

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 162 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # autoship
  2. <p>
  3. <a href="https://vercel.com/labs#past-experiments"><img alt="Vercel Labs Experiment" src="https://img.shields.io/badge/LABS-EXPERIMENT-0a0a0a.svg?style=for-the-badge&amp;logo=Vercel&amp;labelColor=000000" height="28"></a>
  4. <a href="https://www.npmjs.com/package/autoship"><img alt="npm version: autoship" src="https://img.shields.io/npm/v/autoship.svg?style=for-the-badge&amp;labelColor=000000" height="28"></a>
  5. <a href="https://github.com/vercel-labs/autoship/blob/main/LICENSE"><img alt="License: Apache-2.0" src="https://img.shields.io/github/license/vercel-labs/autoship.svg?style=for-the-badge&amp;labelColor=000000" height="28"></a>
  6. <a href="https://www.npmjs.com/package/autoship"><img alt="npm downloads per month: autoship" src="https://img.shields.io/npm/dm/autoship.svg?style=for-the-badge&amp;labelColor=000000&amp;label=npm%20downloads" height="28"></a>
  7. </p>
  8. CLI tool to automate changeset-based releases with AI-generated descriptions.
  9. ## Features
  10. - **AI-Powered Release Analysis** - Automatically suggests release type (patch/minor/major) based on commit history and code changes
  11. - **Smart Changeset Generation** - Generates clear, concise changeset descriptions using AI
  12. - **End-to-End Automation** - Handles the full release workflow from clone to publish
  13. - **CI Integration** - Waits for checks to pass before merging
  14. - **Interactive & Headless Modes** - Use interactively or fully automated with `-y` flag
  15. - **Multi-Repository Support** - Configure and manage multiple repositories
  16. - **Changesets Compatible** - Works with any repository using the changesets workflow
  17. ## Requirements
  18. - **Node.js** 18+
  19. - **Git**
  20. - **GitHub CLI** (`gh`) - authenticated with repo access
  21. - **AI_GATEWAY_API_KEY** environment variable
  22. The target repository must use [changesets](https://github.com/changesets/changesets) for versioning.
  23. ## Setup
  24. ### 1. Authenticate GitHub CLI
  25. ```bash
  26. gh auth login
  27. ```
  28. ### 2. Set your API key
  29. ```bash
  30. export AI_GATEWAY_API_KEY=your-key
  31. ```
  32. ### 3. Add a repository
  33. ```bash
  34. npx autoship add myproject
  35. ```
  36. You'll be prompted for:
  37. - GitHub owner (org or username)
  38. - Repository name
  39. - Base branch (default: `main`)
  40. ## Usage
  41. ### Start a release
  42. ```bash
  43. npx autoship [repo]
  44. ```
  45. If no repo is specified, you'll be prompted to select one.
  46. The tool will:
  47. 1. Clone the repository
  48. 2. Analyze changes since the last version tag
  49. 3. Suggest a release type (patch/minor/major) using AI
  50. 4. Generate a changeset description using AI
  51. 5. Create a PR with the changeset
  52. 6. Wait for CI checks to pass
  53. 7. Merge the changeset PR
  54. 8. Wait for the Version Packages PR (created by changesets action)
  55. 9. Merge the Version Packages PR to publish
  56. ### Options
  57. ```
  58. -t, --type <type> Release type: patch, minor, or major
  59. -m, --message <msg> Release description (skips AI generation)
  60. -y, --yes Skip all confirmations
  61. ```
  62. ### Examples
  63. ```bash
  64. # Interactive release
  65. npx autoship myproject
  66. # Patch release with custom message
  67. npx autoship myproject -t patch -m "Fixed login bug"
  68. # Fully automated minor release
  69. npx autoship myproject -t minor -y
  70. ```
  71. ### List configured repositories
  72. ```bash
  73. npx autoship list
  74. ```
  75. ## Configuration
  76. Config is stored at `~/.autoship/config.json`.
  77. ## Usage with AI Agents
  78. ### Just ask the agent
  79. The simplest approach - just tell your agent to use it:
  80. ```
  81. Use autoship to release my package. Run autoship --help to see available commands.
  82. ```
  83. ### AI Coding Assistants
  84. Add the skill to your AI coding assistant for richer context:
  85. ```bash
  86. npx skills add vercel-labs/autoship
  87. ```
  88. This works with Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Goose, OpenCode, and Windsurf.
  89. ### AGENTS.md / CLAUDE.md
  90. For more consistent results, add to your project or global instructions file:
  91. ```markdown
  92. ## Package Releases
  93. Use `autoship` for releases. Run `autoship --help` for all commands.
  94. Core workflow:
  95. 1. `autoship add <name>` - Configure repository (one-time)
  96. 2. `autoship <name> -t patch -y` - Automated release
  97. ```
  98. ## Contributing
  99. Contributions are welcome! Please feel free to submit a Pull Request.
  100. ```bash
  101. # Clone the repo
  102. git clone https://github.com/vercel-labs/autoship.git
  103. # Install dependencies
  104. pnpm install
  105. # Run tests
  106. pnpm test
  107. # Build
  108. pnpm build
  109. ```
  110. ## License
  111. Apache-2.0

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.