Installation

Getting noto up and running takes less than a minute. Let's walk through it.

Prerequisites

  • Node.js (v18 or higher)
  • Git installed and configured
  • A Gemini API key from Google AI Studio

Quick Install

Install noto globally using the package manager of your choice.

npm install -g @snelusha/noto

That's it! You can now use noto from anywhere in your terminal.

Uninstall

If you ever want to remove noto, use the matching uninstall command for how you installed it:

npm uninstall -g @snelusha/noto

This will completely remove the noto binary from your system. You can safely delete any leftover config at ~/.config/noto/.notorc if you no longer need it.

Coming Soon: Single native executable for zero-dependency installation (track progress)

API Key Setup

noto needs a Gemini API key to generate commit messages. You hve two options:

Add your API key to your shell configuration:

export NOTO_API_KEY="your-gemini-api-key-here"

Option 2: Local Configuration

Set your API key using noto's config command:

noto config key "your-gemini-api-key-here"

This will be stored in a config file at ~/.config/noto/.notorc following XDG standards.

Verify Installation

Check that noto is installed correctly:

noto --version

You should see the current version number. If you do, you're all set!

Upgrading noto

Keep noto up to date with the latest features and improvements:

noto upgrade

noto will automatically check for available updates and install the latest version. If you're already on the latest version, you'll be notified.

Upgrade Options

Control which version to upgrade to:

noto upgrade --stable  # Upgrade to latest stable version
noto upgrade --beta    # Upgrade to latest beta version

Note: By default, the upgrade command automatically chooses the appropriate version based on your current installation. If you're on a prerelease version, it will check for the best available update (stable or beta). Use --stable or --beta to explicitly control the upgrade target.

Having trouble? Check out our troubleshooting guide or open an issue on GitHub.

On this page