Jerry Framework Installation Guide¶

Jerry is a Claude Code plugin for behavior and workflow guardrails.

Table of Contents¶

Section	Purpose
Prerequisites	What you need before installing
Collaborator Installation	SSH setup for private repository access
Installation	Platform-specific setup instructions
Future: Public Repository	When Jerry becomes publicly available
Configuration	Post-installation setup
Verification	How to confirm installation succeeded
Using Jerry	Getting started with skills
Troubleshooting	Common issues and solutions
For Developers	Contributing and development setup
Uninstallation	How to remove Jerry
Getting Help	Support resources and documentation
License	Open source license information

Prerequisites¶

Required Software¶

Software	Version	Purpose	Install Guide
Claude Code	1.0.33+	The AI coding assistant Jerry extends	Setup Guide
Git	2.0+	Clone the Jerry repository	Download
uv	Latest	Python dependency management for hooks	See platform instructions below

Note: You do NOT need Python installed to use Jerry as an end user. Python and uv are used internally by Jerry's hooks. The uv installer handles Python automatically.

System Requirements¶

Requirement	Minimum
Disk Space	~100 MB
Internet	Required for initial clone

Collaborator Installation (Private Repository)¶

Note: Jerry is currently distributed to collaborators only. This section is for users who have been granted collaborator access by a repository administrator. If you are installing from a public repository, skip ahead to Installation.

Jerry is hosted in a private GitHub repository. Before you can clone it, you must:

Receive a collaborator invitation from the Jerry repository administrator
Accept the invitation (check your email or visit github.com/notifications)
Set up SSH authentication — follow the steps below for your platform

Why SSH?¶

Private GitHub repositories require authentication. SSH keys provide secure, password-free access when set up without a passphrase, or when combined with an SSH agent that caches your passphrase (see Tip below). SSH keys are the recommended method. A personal access token (PAT) is an alternative HTTPS-based method; see the PAT Alternative note at the end of this section.

Step 1: Generate an SSH Key¶

Choose your platform:

macOS (Terminal)¶

Warning: If you already have an SSH key, DO NOT overwrite it. Check first, then display your existing public key and skip to Step 2.

First check whether you already have an SSH key:

ls ~/.ssh/id_ed25519.pub 2>/dev/null && echo "Key exists — skip to Step 2" || echo "No key found — proceed below"

If no key was found, open Terminal and run:

ssh-keygen -t ed25519 -C "your.email@example.com"

When prompted: - File location: Press Enter to accept the default (~/.ssh/id_ed25519) - Passphrase: Enter a passphrase (recommended) or press Enter for none

Display your public key:

cat ~/.ssh/id_ed25519.pub

Copy the full output — it begins with ssh-ed25519 and ends with your email address.

Tip: If you set a passphrase, add your key to the macOS Keychain to avoid re-entering it each time:
eval "$(ssh-agent -s)"
ssh-add --apple-use-keychain ~/.ssh/id_ed25519
Without this, your terminal will prompt for your SSH key passphrase every time you interact with GitHub.

Windows (PowerShell)¶

Warning: If you already have an SSH key, DO NOT overwrite it. Check first, then display your existing public key and skip to Step 2.

First check whether you already have an SSH key:

if (Test-Path "$env:USERPROFILE\.ssh\id_ed25519.pub") { Write-Host "Key exists — skip to Step 2" } else { Write-Host "No key found — proceed below" }

If no key was found, open PowerShell and run:

Important — Windows Home / LTSC Users: If ssh-keygen is not recognized, OpenSSH Client is not installed. Install it via Settings → Apps → Optional Features → Add a feature → OpenSSH Client, or run:
Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0
Then close and reopen PowerShell before continuing.

ssh-keygen -t ed25519 -C "your.email@example.com"

When prompted: - File location: Press Enter to accept the default (C:\Users\YOUR_USERNAME\.ssh\id_ed25519) - Passphrase: Enter a passphrase (recommended) or press Enter for none

Display your public key:

Get-Content "$env:USERPROFILE\.ssh\id_ed25519.pub"

Copy the full output — it begins with ssh-ed25519.

Windows Git Bash alternative: If you have Git Bash installed, the macOS Terminal commands above work identically in Git Bash.

Tip: To avoid re-entering your passphrase each session, start the SSH agent. First check if the OpenSSH Client is installed:
# Check if OpenSSH Client is installed
if (Get-Service ssh-agent -ErrorAction SilentlyContinue) {
    Start-Service ssh-agent
    ssh-add "$env:USERPROFILE\.ssh\id_ed25519"
    # To make this permanent:
    Set-Service -Name ssh-agent -StartupType Automatic
} else {
    Write-Host "OpenSSH Client not installed. Install it via:"
    Write-Host "  Settings > Apps > Optional Features > Add a feature > OpenSSH Client"
    Write-Host "Or via PowerShell (requires admin):"
    Write-Host "  Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0"
}
Note: OpenSSH Client is enabled by default on Windows 10 build 1809+ and Windows 11, but may be absent on Home and LTSC editions.

Step 2: Add Your SSH Key to GitHub¶

Go to github.com/settings/keys
Click New SSH key
Give it a descriptive title (e.g., "My MacBook Pro" or "Work Laptop")
Set Key type to Authentication Key
Paste your public key into the Key field
Click Add SSH key

Step 3: Verify SSH Access¶

Confirm GitHub accepts your key:

ssh -T git@github.com

You should see:

Hi YOUR_USERNAME! You've successfully authenticated, but GitHub does not provide shell access.

Note: If you set a passphrase during key generation, you will be prompted to enter it before seeing the success message. Type your passphrase and press Enter. If you see Permission denied (publickey) after entering your passphrase, verify your public key is correctly added to GitHub (Step 2).

If you see a permission denied error, verify your public key was saved correctly at github.com/settings/keys and that you copied the entire key including the ssh-ed25519 prefix.

Step 4: Clone Jerry via SSH¶

Use the SSH clone URL instead of the HTTPS URL:

Important: The clone path must not contain spaces. The Claude Code /plugin marketplace add command does not support paths with spaces. The recommended ~/plugins/ path is safe.

macOS (Terminal) or Git Bash:

mkdir -p ~/plugins
git clone git@github.com:geekatron/jerry.git ~/plugins/jerry

Windows (PowerShell):

New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\plugins"
git clone git@github.com:geekatron/jerry.git "$env:USERPROFILE\plugins\jerry"

Alternative authentication: If you prefer not to use SSH, see PAT Alternative below for HTTPS token-based access.

Next Steps: Complete Platform Installation¶

After cloning via SSH, proceed directly to Step 3: Verify the Plugin Manifest in your platform's installation section below:

macOS — Step 3 onwards
Windows — Step 3 onwards

The remaining steps (plugin manifest, marketplace add, plugin install) are identical regardless of whether you used SSH or HTTPS to clone.

PAT Alternative¶

If you prefer HTTPS authentication, you can use a GitHub Personal Access Token (PAT) instead of SSH keys:

Create a classic PAT at github.com/settings/tokens (select 'Generate new token (classic)') and check the repo scope checkbox. This grants full access to private repositories you collaborate on (read and write). For least-privilege access, use a fine-grained PAT instead with Contents: Read-only permission scoped to the jerry repository only.
When git clone prompts for a password, enter your PAT instead
Use the standard HTTPS clone URL:

Important: If your username contains spaces, use a path without spaces (e.g., ~/plugins/jerry or C:\plugins\jerry).

macOS (Terminal) or Git Bash:

git clone https://github.com/geekatron/jerry.git ~/plugins/jerry

Windows (PowerShell):

git clone https://github.com/geekatron/jerry.git "$env:USERPROFILE\plugins\jerry"

To avoid re-entering your PAT on every git operation, configure a credential helper:

macOS:

First verify that the osxkeychain helper is available on your system:

# Verify osxkeychain helper is available
git credential-osxkeychain 2>&1 | head -1
# If you see "usage: git credential-osxkeychain", proceed.
# If you see "command not found", use the store helper instead:
# git config --global credential.helper store

If osxkeychain is available:

git config --global credential.helper osxkeychain

If osxkeychain is not available (common on conda, nix, or MacPorts installs), use the store helper:

git config --global credential.helper store

Note: The store helper saves credentials in plaintext at ~/.git-credentials. Use it only on single-user machines.

Windows:

git config --global credential.helper manager

Note: Without a credential helper, git will prompt for your PAT on every pull, fetch, and push.

PATs are more common in CI environments. For interactive use, SSH keys are preferred.

Installation¶

Jerry is installed as a Claude Code plugin via a local marketplace. This is a two-step process:

Add the marketplace - Registers Jerry's plugin catalog with Claude Code
Install the plugin - Downloads and activates Jerry's skills

Why the marketplace? Jerry uses Claude Code's plugin system for distribution, scope control, and easy updates. Adding the marketplace first registers Jerry's catalog (the "app store"), so you can then install, update, or uninstall the plugin cleanly with /plugin commands. This separation also lets you control whether Jerry is installed per-user, per-project, or locally — the scope you choose during /plugin install determines who gets it.

Choose your platform below:

macOS¶

Step 1: Install uv¶

uv is required for Jerry's hooks to execute Python scripts with automatic dependency resolution.

curl -LsSf https://astral.sh/uv/install.sh | sh

Restart your terminal (close and reopen), then verify:

uv --version
# Should output: uv 0.x.x

Step 2: Clone Jerry¶

Clone the repository to a location on your system. We recommend ~/plugins/:

Important: The clone path must not contain spaces. The Claude Code /plugin marketplace add command does not support paths with spaces. The recommended ~/plugins/ path is safe.

mkdir -p ~/plugins
git clone https://github.com/geekatron/jerry.git ~/plugins/jerry

Collaborators: If you arrived from the Collaborator Installation section above, you have already cloned via SSH — skip this step and proceed to Step 3 below.

Step 3: Verify the Plugin Manifest¶

Confirm Jerry's plugin manifest exists:

cat ~/plugins/jerry/.claude-plugin/plugin.json

You should see JSON output with "name": "jerry". This confirms the path is correct and the .claude-plugin/plugin.json manifest is present in the repository.

Step 4: Add the Local Marketplace¶

Open Claude Code and run:

/plugin marketplace add ~/plugins/jerry

This registers Jerry's plugin catalog. No plugins are installed yet—you're just adding the "app store."

Step 5: Install the Plugin¶

Install Jerry from the marketplace:

/plugin install jerry@jerry-framework

Note: The @jerry-framework suffix is the marketplace name (from marketplace.json). This is fixed regardless of the directory name you cloned to.

Alternative: Interactive Installation 1. Run /plugin 2. Go to the Discover tab 3. Find jerry 4. Press Enter and select your installation scope: - User (recommended): Install for yourself across all projects - Project: Install for all collaborators on this repository - Local: Install for yourself in this repository only

Windows¶

Step 1: Install uv¶

Open PowerShell (not Command Prompt) and run:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Important: Close and reopen PowerShell to update your PATH.

Verify the installation:

uv --version
# Should output: uv 0.x.x

If you see "command not found," ensure this path is in your system PATH:

%USERPROFILE%\.local\bin

Step 2: Clone Jerry¶

Clone the repository using PowerShell:

Important: The clone path must not contain spaces. The Claude Code /plugin marketplace add command does not support paths with spaces. The recommended $env:USERPROFILE\plugins\ path is safe (your Windows username does not typically contain spaces, but if it does, choose an alternate path such as C:\plugins\).

# Create plugins directory
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\plugins"

# Clone Jerry
git clone https://github.com/geekatron/jerry.git "$env:USERPROFILE\plugins\jerry"

Alternative using Git Bash:

mkdir -p ~/plugins
git clone https://github.com/geekatron/jerry.git ~/plugins/jerry

Collaborators: If you arrived from the Collaborator Installation section above, you have already cloned via SSH — skip this step and proceed to Step 3 below.

Step 3: Verify the Plugin Manifest¶

Confirm Jerry's plugin manifest exists:

Get-Content "$env:USERPROFILE\plugins\jerry\.claude-plugin\plugin.json"

You should see JSON output with "name": "jerry". This confirms the path is correct and the .claude-plugin\plugin.json manifest is present in the repository.

Step 4: Add the Local Marketplace¶

Open Claude Code and run (note: use forward slashes in Claude Code):

/plugin marketplace add C:/Users/YOUR_USERNAME/plugins/jerry

Replace YOUR_USERNAME with your actual Windows username.

Tip: To get the exact forward-slash path that Claude Code expects, run this in PowerShell:

(Get-Item "$env:USERPROFILE\plugins\jerry").FullName -replace '\\','/'

Copy the output and use it directly in the /plugin marketplace add command.

Step 5: Install the Plugin¶

Install Jerry from the marketplace:

/plugin install jerry@jerry-framework

Note: The @jerry-framework suffix is the marketplace name (from marketplace.json). This is fixed regardless of the directory name you cloned to.

Future: Public Repository Installation¶

Note: This section documents a future installation scenario. Jerry is currently distributed to collaborators only. When Jerry is released as a public repository, these simplified instructions will apply and no SSH setup or collaborator invitation is required.

When Jerry becomes publicly available, installation simplifies significantly:

No prerequisites beyond Git, uv, and Claude Code. No GitHub account is required to clone a public repository, and no SSH key setup or collaborator invitation is needed. Note that unauthenticated HTTPS clones may be subject to GitHub API rate limits during periods of high traffic. If you encounter rate-limiting errors, authenticating with a GitHub account resolves this.

Simplified Installation Steps¶

Step 1: Install uv — identical to the platform-specific steps above. See macOS Installation or Windows Installation for platform-specific uv installation.

Step 2: Clone Jerry (HTTPS)

Important: If your username contains spaces, use a path without spaces (e.g., ~/plugins/jerry or C:\plugins\jerry).

# macOS/Linux
git clone https://github.com/geekatron/jerry.git ~/plugins/jerry

# Windows PowerShell
git clone https://github.com/geekatron/jerry.git "$env:USERPROFILE\plugins\jerry"

Steps 3–5: Identical to the existing marketplace steps — verify the plugin manifest, add the local marketplace, and install the plugin. See macOS Installation or Windows Installation for platform-specific steps.

What Changes vs. Collaborator Installation¶

Aspect	Current (Collaborator)	Future (Public)
GitHub account needed	Yes (for collaborator access)	No
SSH key setup	Required	Not required
Collaborator invite	Required from repo admin	Not required
Clone URL	SSH: `git@github.com:...`	HTTPS: `https://github.com/...`
Marketplace steps	Identical	Identical

To check whether Jerry is now publicly available, visit github.com/geekatron/jerry while logged out of GitHub — if the page loads without a login prompt, these simplified instructions apply. If you encounter authentication prompts when following these future steps, the repository has not yet been made public.

Configuration¶

Installation Scopes Explained¶

When installing plugins, you choose a scope that determines where the plugin is available:

Scope	Where Installed	Use Case
User (default)	Your user settings	Personal use across all your projects
Project	`.claude/settings.json`	Shared with team—all collaborators get the plugin
Local	Your local repo config	Testing—only you, only this repo

Recommendation: Use User scope for personal use. Use Project scope when you want your whole team to have Jerry available. When Project scope is selected, Jerry is added to .claude/settings.json, which is committed to version control — new team members have Jerry active automatically after cloning the repository.

Project Setup (Optional)¶

Jerry uses project-based workflows for organizing work. To set up a project:

Set the project environment variable:

# macOS/Linux
export JERRY_PROJECT=PROJ-001-my-project

# Windows PowerShell
$env:JERRY_PROJECT = "PROJ-001-my-project"

Create project structure:

# macOS/Linux
mkdir -p projects/PROJ-001-my-project/.jerry/data/items

# Windows PowerShell
New-Item -ItemType Directory -Force -Path "projects\PROJ-001-my-project\.jerry\data\items"

The SessionStart hook will automatically load project context when you start Claude Code.

Verification¶

Check Plugin Installation¶

In Claude Code, run /plugin
Go to the Installed tab
Verify jerry appears in the list

Check for Errors¶

Run /plugin
Go to the Errors tab
Verify no errors related to jerry

Test a Skill¶

Run a simple skill to verify everything works:

/problem-solving

You should see the problem-solving skill activate with information about available agents.

Note: /problem-solving requires an active project (JERRY_PROJECT environment variable set). If you skipped the Configuration section, use /help instead to verify skill availability without a project.

Using Jerry¶

New to Jerry? Follow the Getting Started runbook for a guided walkthrough from installation to your first persisted skill output.

Available Skills¶

After installation, these skills are available via slash commands:

Skill	Command	Purpose
Problem-Solving	`/problem-solving`	Research, analysis, architecture decisions
Work Tracker	`/worktracker`	Task and work item management
NASA SE	`/nasa-se`	Systems engineering processes (NPR 7123.1D)
Orchestration	`/orchestration`	Multi-phase workflow coordination
Architecture	`/architecture`	Design decisions and ADRs
Transcript	`/transcript`	Meeting transcript parsing
Adversary	`/adversary`	Adversarial quality reviews and tournament scoring

Example Usage¶

Research a topic:

/problem-solving research OAuth2 implementation patterns for Python

Create a work item:

/worktracker add "Implement user authentication"

Make an architecture decision:

/architecture create ADR for choosing PostgreSQL over SQLite

Persistent Artifacts¶

All skill outputs are saved to files in your project:

Output Type	Location
Research	`docs/research/`
Analysis	`docs/analysis/`
Critiques	`docs/critiques/`
Decisions (ADRs)	`docs/decisions/`
Investigations	`docs/investigations/`
Reviews	`docs/reviews/`
Reports	`docs/reports/`
Synthesis	`docs/synthesis/`

These files survive context compaction and session boundaries, building your project's knowledge base over time.

Troubleshooting¶

Plugin Command Not Recognized¶

Symptom: /plugin command not found or doesn't work

Solution: Update Claude Code to the latest version: - macOS (Homebrew): brew upgrade claude-code - npm: npm update -g @anthropic-ai/claude-code

Plugin support requires Claude Code version 1.0.33 or later.

Plugin Not Found After Adding Marketplace¶

Symptom: /plugin install jerry@jerry-framework returns "plugin not found"

Solutions: 1. Verify the marketplace was added: /plugin marketplace list 2. Check the path is correct and Jerry was cloned successfully 3. Refresh the marketplace: /plugin marketplace update jerry-framework 4. Verify the manifest exists: cat ~/plugins/jerry/.claude-plugin/plugin.json 5. If the marketplace was registered under a different name, the @ suffix in the install command must match. Run /plugin marketplace list to verify the marketplace name

uv: command not found¶

Symptom: Hooks fail with "uv: command not found"

Solution (macOS):

curl -LsSf https://astral.sh/uv/install.sh | sh
# Restart your terminal

Solution (Windows):

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# Close and reopen PowerShell

If still not found, add to PATH manually: - macOS: export PATH="$HOME/.local/bin:$PATH" (add to ~/.zshrc) - Windows: Add %USERPROFILE%\.local\bin to System PATH

Skills Not Appearing¶

Symptom: Installed plugin but /problem-solving doesn't work

Solutions: 1. Check the Errors tab in /plugin 2. Clear the plugin cache: - macOS: rm -rf ~/.claude/plugins/cache - Windows: Remove-Item -Recurse -Force "$env:USERPROFILE\.claude\plugins\cache" 3. Restart Claude Code 4. Reinstall the plugin: /plugin uninstall jerry@jerry-framework then /plugin install jerry@jerry-framework

Path Issues on Windows¶

Symptom: "path not found" when adding marketplace

Solutions: - Use forward slashes in Claude Code: C:/Users/name/plugins/jerry - Or use short path: ~/plugins/jerry (if using Git Bash paths) - Avoid using backslashes or environment variables in the Claude Code command

SSH Authentication Failed (Collaborators)¶

Symptom: git clone git@github.com:geekatron/jerry.git returns "Permission denied (publickey)"

Causes: SSH key not added to GitHub, passphrase not entered when prompted during ssh -T, key not loaded in ssh-agent, or collaborator invitation not accepted.

Solutions: 1. Verify your SSH key was added to GitHub: visit github.com/settings/keys 2. Test SSH connectivity: ssh -T git@github.com — if prompted for a passphrase, enter it; a successful response rules out key/auth issues 3. Confirm your key file exists: ls ~/.ssh/id_ed25519.pub (macOS) or Test-Path "$env:USERPROFILE\.ssh\id_ed25519.pub" (Windows) 4. If you have multiple SSH keys, ensure the correct one is loaded: ssh-add -l 5. Verify you accepted the collaborator invitation at github.com/notifications

Repository Not Found (Collaborators)¶

Symptom: git clone returns "repository not found" or 404

Solutions: 1. Confirm you were added as a collaborator and accepted the invitation 2. Verify your GitHub username has access by visiting the repository URL in a browser while logged in 3. Try SSH connectivity test first: ssh -T git@github.com — must show your GitHub username

Credential Helper Not Found (macOS PAT Users)¶

Symptom: git credential-osxkeychain returns "command not found" after running git config --global credential.helper osxkeychain

Cause: The osxkeychain helper ships with Apple's Git (Xcode Command Line Tools) but is not included with Git installed via conda, Homebrew's git formula on some configurations, nix, or MacPorts.

Solution: Use the store helper instead:

git config --global credential.helper store

The first time you run a git operation, enter your PAT when prompted — it will be saved to ~/.git-credentials for future use.

Security note: The store helper saves credentials in plaintext. For better security, install the Xcode Command Line Tools (xcode-select --install) to get the osxkeychain helper.

Project Not Configured (`<project-required>` or `<project-error>`)¶

Symptom: Running /problem-solving or other skills shows XML-tagged output like <project-required> or <project-error> instead of the expected skill response.

Cause: The JERRY_PROJECT environment variable is not set, is set to a non-existent project, or the project directory structure is incomplete.

Solutions: 1. Set the environment variable: export JERRY_PROJECT=PROJ-001-my-project (macOS) or $env:JERRY_PROJECT = "PROJ-001-my-project" (Windows PowerShell) 2. Verify the project directory exists: ls projects/$JERRY_PROJECT/ — it should contain PLAN.md and WORKTRACKER.md 3. If you haven't created a project yet, follow the Configuration section above 4. Use /help to verify Jerry is installed — this command works without a project configured

For Developers¶

If you want to contribute to Jerry development, you'll need Python 3.11+ and uv.

Development Setup¶

macOS / Linux:

git clone https://github.com/geekatron/jerry.git
cd jerry
make setup    # Installs deps + pre-commit hooks
make test     # Run test suite

Windows (Git Bash or PowerShell):

git clone https://github.com/geekatron/jerry.git
cd jerry
uv sync                        # Install dependencies
uv run pre-commit install      # Install pre-commit hooks
uv run pytest --tb=short -q    # Run test suite

Note: Windows does not have make by default. Use the uv run commands directly. See CONTRIBUTING.md for the full Make target equivalents table.

Common Developer Commands¶

Task	macOS/Linux	Windows / All Platforms
First-time setup	`make setup`	`uv sync && uv run pre-commit install`
Run tests	`make test`	`uv run pytest --tb=short -q`
Run linters	`make lint`	`uv run ruff check src/ tests/ && uv run pyright src/`
Format code	`make format`	`uv run ruff check --fix src/ tests/ && uv run ruff format src/ tests/`
All pre-commit hooks	`make pre-commit`	`uv run pre-commit run --all-files`

Context Distribution (Bootstrap)¶

Jerry's behavioral rules live in .context/ (canonical source) and are synced to .claude/ via symlinks. After cloning, run the bootstrap:

uv run python scripts/bootstrap_context.py        # Set up symlinks
uv run python scripts/bootstrap_context.py --check # Verify sync

See Bootstrap Guide (located in the docs/ directory) for platform-specific details.

Architecture Overview¶

Jerry follows hexagonal architecture:

src/
├── domain/           # Pure business logic (no external deps)
├── application/      # Use cases (CQRS commands/queries)
├── infrastructure/   # Adapters (persistence, messaging)
└── interface/        # Primary adapters (CLI)

See CONTRIBUTING.md for detailed contribution guidelines, Windows-specific notes, and coding standards.

Uninstallation¶

Remove the Plugin¶

/plugin uninstall jerry@jerry-framework

Remove the Marketplace¶

/plugin marketplace remove jerry-framework

Delete Local Files (Optional)¶

macOS/Linux:

rm -rf ~/plugins/jerry

Windows PowerShell:

Remove-Item -Recurse -Force "$env:USERPROFILE\plugins\jerry"

Getting Help¶

GitHub Issues: github.com/geekatron/jerry/issues
Documentation: docs/ directory in the repository
Claude Code Help: Run /help in Claude Code

License¶

Jerry Framework is open source under the Apache License 2.0.

Jerry Framework Installation Guide¶

Table of Contents¶

Prerequisites¶

Required Software¶

System Requirements¶

Collaborator Installation (Private Repository)¶

Why SSH?¶

Step 1: Generate an SSH Key¶

macOS (Terminal)¶

Windows (PowerShell)¶

Step 2: Add Your SSH Key to GitHub¶

Step 3: Verify SSH Access¶

Step 4: Clone Jerry via SSH¶

Next Steps: Complete Platform Installation¶

PAT Alternative¶

Installation¶

macOS¶

Step 1: Install uv¶

Step 2: Clone Jerry¶

Step 3: Verify the Plugin Manifest¶

Step 4: Add the Local Marketplace¶

Step 5: Install the Plugin¶

Windows¶

Step 1: Install uv¶

Step 2: Clone Jerry¶

Step 3: Verify the Plugin Manifest¶

Step 4: Add the Local Marketplace¶

Step 5: Install the Plugin¶

Future: Public Repository Installation¶

Simplified Installation Steps¶

What Changes vs. Collaborator Installation¶

Configuration¶

Installation Scopes Explained¶

Project Setup (Optional)¶

Verification¶

Check Plugin Installation¶

Check for Errors¶

Test a Skill¶

Using Jerry¶

Available Skills¶

Example Usage¶

Persistent Artifacts¶

Troubleshooting¶

Plugin Command Not Recognized¶

Plugin Not Found After Adding Marketplace¶

uv: command not found¶

Skills Not Appearing¶

Path Issues on Windows¶

SSH Authentication Failed (Collaborators)¶

Repository Not Found (Collaborators)¶

Credential Helper Not Found (macOS PAT Users)¶

Project Not Configured (<project-required> or <project-error>)¶

For Developers¶

Development Setup¶

Common Developer Commands¶

Context Distribution (Bootstrap)¶

Architecture Overview¶

Uninstallation¶

Remove the Plugin¶

Remove the Marketplace¶

Delete Local Files (Optional)¶

Getting Help¶

License¶

Project Not Configured (`<project-required>` or `<project-error>`)¶