Installation

tcxcommit can be installed globally via npm or used directly with npx. Choose whichever method works best for your workflow.

Prerequisites

• Node.js (v18 or higher)
• Git (installed and configured)
• An OpenRouter API key (optional - 5 free trials included)

Quick Install

Install using npm:

npm install -g tcxcommit

Or use directly with npx (no installation needed):

npx tcxcommit

Verify Installation

Check if tcxcommit is installed:

tcxcommit --version

Configuration

API Key Setup

By default, tcxcommit gives you 5 free trials. After that, you'll need your own OpenRouter API key:

1. Visit OpenRouter.ai
2. Create an account and get your API key
3. When prompted in tcxcommit, enter your API key
4. The key is saved to .env file automatically

Environment Variables

Your .env file will be created automatically with:

OPENROUTER_API_KEY=your-api-key-here
FREE_TRIALS=5

Update

To update to the latest version:

npm update -g tcxcommit

Uninstall

To remove tcxcommit:

npm uninstall -g tcxcommit

Next Steps

Now that you have tcxcommit installed, check out the Usage guide to start generating commit messages!