claudeup

module
v5.14.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2026 License: MIT

README

claudeup

A CLI tool for managing Claude Code profiles and configurations.

Documentation

Why ClaudeUp

Claude Code stores its configuration across multiple files and scopes. claudeup solves the problems that come with managing these configurations by hand:

  • Portable setups -- Save your entire Claude configuration (plugins, MCP servers, settings) as a profile. Apply it on any machine in one command.
  • Team sharing -- Apply a profile at project scope, commit the resulting config files to git, and every team member gets the same setup.
  • Project switching -- Keep separate profiles for frontend, backend, or client work. Switch between them instantly.
  • Diagnostics -- claudeup doctor catches common issues. Event tracking shows exactly what changed and when.

claudeup is designed to bootstrap your setup and get out of the way. After applying a profile, you manage settings directly through Claude Code's native files.

Install

# One-liner install (macOS/Linux)
curl -fsSL https://claudeup.github.io/install.sh | bash

# Or from source
go install github.com/claudeup/claudeup/v5/cmd/claudeup@latest

Get Started

# Setup preserves existing Claude Code configuration
claudeup setup

# For fresh installations, apply a specific profile
claudeup setup --profile frontend

For existing Claude Code users: Setup detects your current installation and preserves it. You'll be offered the option to save your existing configuration as a profile. Enabled plugins are automatically installed -- no separate profile apply needed.

For new users: Setup applies the default profile (or your specified --profile) to get you started with plugins and MCP servers.

Key Features

Profiles

Save and switch between different Claude configurations. Great for different projects or sharing setups across machines.

claudeup profile list              # See available profiles
claudeup profile save my-setup     # Save current config as a profile
claudeup profile apply backend     # Switch to a different profile

Profiles include plugins, MCP servers, marketplaces, and secrets. Learn more → | Community profiles →

Team Configuration

Share Claude configurations with your team via git:

# Team lead: Save profile and share via project settings
claudeup profile save team-config
claudeup profile apply team-config --project
git add .claude/settings.json && git commit -m "Add team profile"

# Team member: Apply after clone/pull
claudeup profile apply team-config --project

Profiles capture settings from all scopes (user, project, local). Use profile apply --project to write settings to .claude/settings.json for team sharing. Learn more →

Plugin Discovery

Find plugins by capability:

claudeup status                       # Overview of your installation
claudeup plugin search tdd            # Find plugins by capability
claudeup plugin search api --all      # Search all cached plugins
claudeup plugin browse my-marketplace # Browse marketplace plugins

Full command reference →

Diagnostics & Maintenance
claudeup doctor     # Diagnose issues
claudeup cleanup    # Fix plugin path problems
claudeup outdated   # Check for updates
claudeup update     # Update claudeup CLI
claudeup upgrade    # Update plugins and marketplaces

Troubleshooting guide →

Commands

Update Commands
Command Description
claudeup update Update the claudeup CLI to the latest version
claudeup upgrade Update marketplaces and plugins
claudeup outdated Show available updates for CLI, marketplaces, and plugins

For the complete command reference, see Full command reference →

Environment Variables

Variable Description Default
CLAUDEUP_HOME Override claudeup's configuration directory ~/.claudeup
CLAUDE_CONFIG_DIR Override Claude Code's configuration directory ~/.claude
Isolated Testing Environment

Use environment variables to run claudeup in isolation (useful for testing or CI):

export CLAUDEUP_HOME="/tmp/test-env/.claudeup"
export CLAUDE_CONFIG_DIR="/tmp/test-env/.claude"
claudeup profile apply base-tools

Documentation

License

MIT

Directories

Path Synopsis
cmd
claudeup command
ABOUTME: Entry point for the claudeup CLI tool ABOUTME: Initializes and executes the root command
ABOUTME: Entry point for the claudeup CLI tool ABOUTME: Initializes and executes the root command
internal
backup
ABOUTME: Backup and restore functionality for scope settings ABOUTME: Manages ~/.claudeup/backups/ for scope recovery
ABOUTME: Backup and restore functionality for scope settings ABOUTME: Manages ~/.claudeup/backups/ for scope recovery
breadcrumb
ABOUTME: Manages per-scope breadcrumbs recording which profile was last applied ABOUTME: Enables profile diff and save to default to the last-applied profile
ABOUTME: Manages per-scope breadcrumbs recording which profile was last applied ABOUTME: Enables profile diff and save to default to the last-applied profile
claude
ABOUTME: Custom error types for Claude CLI compatibility issues ABOUTME: Provides structured errors with actionable user guidance
ABOUTME: Custom error types for Claude CLI compatibility issues ABOUTME: Provides structured errors with actionable user guidance
commands
ABOUTME: Cleanup command implementation for fixing and removing plugin entries ABOUTME: Fixes correctable path issues and removes truly broken plugins
ABOUTME: Cleanup command implementation for fixing and removing plugin entries ABOUTME: Fixes correctable path issues and removes truly broken plugins
config
ABOUTME: Global configuration flags for claudeup ABOUTME: Stores runtime flag values accessible across commands
ABOUTME: Global configuration flags for claudeup ABOUTME: Stores runtime flag values accessible across commands
events
ABOUTME: Diff functionality for comparing file snapshots and generating ABOUTME: human-readable summaries of what changed between before/after states.
ABOUTME: Diff functionality for comparing file snapshots and generating ABOUTME: human-readable summaries of what changed between before/after states.
ext
ABOUTME: Manages enabled.json configuration file for extensions ABOUTME: Provides load/save operations for tracking enabled state in CLAUDEUP_HOME
ABOUTME: Manages enabled.json configuration file for extensions ABOUTME: Provides load/save operations for tracking enabled state in CLAUDEUP_HOME
mcp
ABOUTME: MCP server discovery functionality ABOUTME: Scans plugins for mcp.json files and parses server definitions
ABOUTME: MCP server discovery functionality ABOUTME: Scans plugins for mcp.json files and parses server definitions
profile
ABOUTME: Applies a profile to Claude Code using replace strategy ABOUTME: Computes diff, resolves secrets, executes via claude CLI
ABOUTME: Applies a profile to Claude Code using replace strategy ABOUTME: Computes diff, resolves secrets, executes via claude CLI
secrets
ABOUTME: Environment variable secret resolver ABOUTME: Reads secrets from environment variables
ABOUTME: Environment variable secret resolver ABOUTME: Reads secrets from environment variables
selfupdate
ABOUTME: Self-update functionality for claudeup CLI ABOUTME: Downloads and replaces binary from GitHub releases
ABOUTME: Self-update functionality for claudeup CLI ABOUTME: Downloads and replaces binary from GitHub releases
ui
Package ui provides consistent terminal styling and output formatting for claudeup CLI commands using lipgloss.
Package ui provides consistent terminal styling and output formatting for claudeup CLI commands using lipgloss.
test
acceptance
ABOUTME: Acceptance test helpers for end-to-end testing ABOUTME: Provides real Claude installation fixtures and utilities
ABOUTME: Acceptance test helpers for end-to-end testing ABOUTME: Provides real Claude installation fixtures and utilities
helpers
ABOUTME: Result type for capturing CLI command output ABOUTME: Used by TestEnv to return stdout, stderr, and exit code
ABOUTME: Result type for capturing CLI command output ABOUTME: Used by TestEnv to return stdout, stderr, and exit code
integration
ABOUTME: Integration test helpers for setting up test fixtures ABOUTME: Creates fake Claude installations for testing
ABOUTME: Integration test helpers for setting up test fixtures ABOUTME: Creates fake Claude installations for testing

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL