Journeymen
CLI Documentation

Journeymen CLI

Analyze your git history and submit projects for grading. Your code stays on your machine — only aggregated data leaves.

Download CLI
Private by defaultNo dependenciesGitHub verifiedLive analysis

Installation

Get the Journeymen CLI up and running in seconds

Download

Grab the binary for your platform from the download page. No dependencies required.

bash
# macOS
chmod +x journeymen-macos

# Linux
chmod +x journeymen-linux

# Windows
# Just run the downloaded .exe

Sign In

Verify your identity with GitHub Device Flow

Authenticate with GitHub

Uses GitHub Device Flow for secure authentication. Your GitHub token is never written to disk.

journeymen auth login

What happens:

  1. 1.You’ll get a short device code and a github.com URL
  2. 2.Open the URL and enter the device code
  3. 3.Approve the authorization
  4. 4.Token is saved locally at ~/.journeymen/credentials.json

Analyze Your Project

Preview what will be submitted without uploading anything

Analyze Local Repository

Reads your local git history and shows per-author breakdown. Nothing leaves your machine.

journeymen analyze /path/to/your/project

Analysis output includes:

  • ✓Per-author commit counts
  • ✓Lines added/removed breakdown
  • ✓Language detection by file extension
  • ✓Best-effort activity timeline
  • ✓Full disclosure of what gets sent

Submit for Grading

Send your analysis to Journeymen for evaluation

Submit Project

Runs analysis and asks for confirmation before sending — no graph.json or README.md involved.

journeymen submit /path/to/your/project \
  --project-id <your-project-id>

AI-assisted checks (server-side, automatic)

Compulsory checks run entirely server-side once you submit — this CLI never calls them itself and sends no repo content for them to use.

Activity Pattern Analysis

Validates commit timing looks organic relative to codebase size

Code Quality Judgment

Judges complexity, duplication, test coverage, and documentation from a clone the server makes itself

Framework Detection

Deterministic — parsed from manifest files (package.json, Pipfile, etc.), not AI-judged

Using your own OpenAI key

By default, Journeymen uses its own key (rate-capped per day). Switch to your own with:

bash
# Use your own key
journeymen ai configure --byok-key sk-...

# Switch back to Journeymen's key
journeymen ai configure --platform

Map Git Identities

Link your local git email to your GitHub handles

Map Email to GitHub Handle

Interactive tool to match unresolved commit emails to your verified GitHub handles.

journeymen identity map /path/to/your/project

The mapping is saved to ~/.journeymen/identity_map.json and applied automatically to all future analyses. This only affects how your name is displayed — scoring is always verified against GitHub’s server-side data.

What Gets Sent

Complete transparency about your data

✓ Sent to Journeymen

  • +Per-author commit counts
  • +Line add/remove totals
  • +First/last commit timestamps & SHAs
  • +Commit email addresses
  • +Language line-count breakdown

✗ Never Sent

  • –File contents
  • –Commit messages
  • –Diffs
  • –Full commit list
  • –Other repositories
  • –Your GitHub token
  • –graph.json or README.md content

Troubleshooting

Solutions to common issues