Quickstart

This guide will help you set up Nyron in your project and create your first automated release.

Initialize Nyron

Run the initialization command to create a configuration file:

npx @nyron/cli init

This creates a nyron.config.ts file in your project root with the following structure:

import { defineConfig } from "@nyron/cli/config"

export default defineConfig({
  repo: "owner/repo", // Your GitHub repo
  projects: {
    sdk: {
      tagPrefix: "@my-package/sdk@",
      path: "packages/sdk",
    },
    service: {
      tagPrefix: "@my-package/service@",
      path: "apps/service",
    },
  },
  autoChangelog: true,
  onPushReminder: true,
})

Edit this file to match your project structure.

Single-Package Repository

For a single-package repo, use this simpler configuration:

import { defineConfig } from "@nyron/cli/config"

export default defineConfig({
  repo: "your-org/your-repo",
  projects: {
    main: {
      tagPrefix: "v",
      path: ".",
    },
  },
  autoChangelog: true,
  onPushReminder: true,
})

Setup GitHub Token (Required)

Nyron requires a GitHub token to function properly:

# Create .env in your project root
echo "GITHUB_TOKEN=your_github_token_here" > .env

Generate a token at GitHub Settings → Developer settings → Personal access tokens and ensure you check all of the following permissions:

repo (Full control of private repositories)
repo:status (Access commit status)
repo_deployment (Access deployment status)
public_repo (Access public repositories)
repo:invite (Access repository invitations)
security_events (Read and write security events)

A GitHub token is required for Nyron to access repository metadata, commit information, and create releases. Be sure to select all the permissions listed above. Without the correct permissions, Nyron will not work.

Start Using Nyron

Now you're ready to use Nyron! Here's the typical workflow:

1. Bump version and auto-generate changelog

npx @nyron/cli bump --type minor --prefix v

2. Commit your changes

git add .
git commit -m "chore: bump version to 1.2.0"

3. Create and push nyron-release tag

npx @nyron/cli push-tag

4. Create GitHub release

npx @nyron/cli release

Next Steps

Important: For the best experience with Nyron, configure your GitHub repository settings to enforce clean commit history and conventional commit format. See the GitHub repository setup guide for required settings.

Learn about configuration options
Explore all available commands
Understand how Nyron works
Read about conventional commits

Quickstart

On this page