Skip to content

pguilbert/aidescribe

Repository files navigation

aidescribe

CLI that generates Jujutsu change descriptions with AI.

aidescribe demo

Quick Start

# run without installing
npx aidescribe

# or install globally
npm i -g aidescribe

Generate a description:

# supported `jj` target arguments
aidescribe
aidescribe <REVSETS>
aidescribe -r @-
aidescribe -r abc123
aidescribe -rabc123

Only inlined <REVSETS> and -r are forwarded to jj.

Requirements

  • Node.js >=22
  • jj installed
  • Run inside a Jujutsu repository

Setup

Run the interactive setup once to connect your AI provider and save config:

aidescribe connect

This saves config to ~/.aidescribe.json. Currently OpenAI, Anthropic, and Mistral providers are supported.

Config

View config:

aidescribe config
aidescribe config get provider
aidescribe config set variantCount=3

Usage

aidescribe v0.0.4

Generate jj change descriptions with AI

Usage:
  aidescribe [flags...]
  aidescribe <command>

Commands:
  config         View or modify configuration settings
  connect        Interactive provider setup wizard

Flags:
      --count <number>                 Generate multiple description variants for this run (default: 1)
  -h, --help                           Show help
      --locale <string>                Override locale for this run (default: en)
      --max-diff-chars <number>        Max diff chars sent to AI for this run (default: 40000)
      --max-length <number>            Max generated title length for this run (default: 72, its a soft guidance for the
                                       model, not a local hard cutoff)
      --provider <string>              Override provider for this run (supported: openai, anthropic, mistral)
  -t, --type <string>                  Message format for this run (default: conventional, supports: conventional, plain)
      --verbose                        Print the exact prompt payload sent to the AI model for this run
      --version                        Show version

About

A CLI that writes your JJ change description for you using AI.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors