Skip to content

Latest commit

 

History

History
363 lines (261 loc) · 6.71 KB

installation.md

File metadata and controls

363 lines (261 loc) · 6.71 KB

Installation Guide

Complete installation instructions for Claude Code Tresor.

Prerequisites

Before installing Claude Code Tresor, ensure you have:

  • Claude Code CLI installed and configured
  • Git installed (version 2.0 or higher)
  • Terminal/Command Line access
  • Text Editor for customization (optional)

Verify Prerequisites

# Check Claude Code CLI
claude --version

# Check Git
git --version

Installation Methods

Claude Code Tresor supports three installation methods:

Method 1: Full Installation (Recommended)

Installs all components: 8 skills + 8 agents + 4 commands

# Clone repository
git clone https://github.com/alirezarezvani/claude-code-tresor.git
cd claude-code-tresor

# Run installation script
./scripts/install.sh

What gets installed:

  • 8 autonomous skills in ~/.claude/skills/
  • 8 specialized agents in ~/.claude/agents/
  • 4 slash commands in ~/.claude/commands/
  • Prompt templates and standards

Installation time: ~2-3 minutes

Method 2: Selective Installation

Install only specific components:

Skills Only (8 Autonomous Skills)

./scripts/install.sh --skills

Installs:

  • code-reviewer
  • test-generator
  • git-commit-helper
  • security-auditor
  • secret-scanner
  • dependency-auditor
  • api-documenter
  • readme-updater

Agents Only (8 Expert Agents)

./scripts/install.sh --agents

Installs:

  • @code-reviewer
  • @test-engineer
  • @docs-writer
  • @architect
  • @debugger
  • @security-auditor
  • @performance-tuner
  • @refactor-expert

Commands Only (4 Workflow Commands)

./scripts/install.sh --commands

Installs:

  • /scaffold
  • /review
  • /test-gen
  • /docs-gen

Method 3: Resources Only

Install prompts, templates, and standards without skills/agents/commands:

./scripts/install.sh --resources-only

Use this if you only want reference materials and templates.

Verification Steps

After installation, verify everything works:

1. Verify Skills Installation

# Check installed skills
ls ~/.claude/skills/

# Expected output:
# code-reviewer/
# test-generator/
# git-commit-helper/
# security-auditor/
# secret-scanner/
# dependency-auditor/
# api-documenter/
# readme-updater/

2. Verify Agents Installation

# Check installed agents
ls ~/.claude/agents/

# Expected output:
# code-reviewer/
# test-engineer/
# docs-writer/
# architect/
# debugger/
# security-auditor/
# performance-tuner/
# refactor-expert/

3. Verify Commands Installation

# Check installed commands
ls ~/.claude/commands/

# Expected output:
# scaffold/
# review/
# test-gen/
# docs-gen/

4. Test Installation

Start Claude Code and test components:

# Start Claude Code
claude

# In conversation, skills activate automatically when you save code files

# Test an agent
@code-reviewer analyze this function for best practices

# Test a command
/scaffold --help

Common Installation Issues

Issue: Permission Denied

Error: Permission denied: ./scripts/install.sh

Solution:

# Make install script executable
chmod +x ./scripts/install.sh

# Run installation again
./scripts/install.sh

Issue: Script Not Found

Error: ./scripts/install.sh: No such file or directory

Solution:

# Ensure you're in repository root
pwd  # Should show: .../claude-code-tresor

# List scripts directory
ls scripts/

# If missing, re-clone repository
cd ..
rm -rf claude-code-tresor
git clone https://github.com/alirezarezvani/claude-code-tresor.git
cd claude-code-tresor

Issue: Skills Not Activating

Problem: Skills installed but not activating in conversations

Solution:

  1. Restart Claude Code CLI
  2. Verify skills are in ~/.claude/skills/
  3. Check skill configuration:
cat ~/.claude/skills/code-reviewer/SKILL.md
  1. Ensure trigger keywords are used (see Getting Started Guide)

Issue: Agents Not Found

Problem: @agent-name not found

Solution:

  1. Verify agent directory exists:
ls ~/.claude/agents/code-reviewer/
  1. Check agent configuration:
cat ~/.claude/agents/code-reviewer/SKILL.md
  1. Restart Claude Code CLI

Issue: Commands Not Working

Problem: /command-name not recognized

Solution:

  1. Verify command directory exists:
ls ~/.claude/commands/scaffold/
  1. Check command configuration:
cat ~/.claude/commands/scaffold/command.json
  1. Restart Claude Code CLI
  2. Try full command path: /development/scaffold instead of /scaffold

Post-Installation Next Steps

After successful installation:

  1. Read Getting Started Guide →

    • Learn how to use skills, agents, and commands
    • Follow first-time user walkthrough

  2. Explore Examples →

    • See real-world workflows
    • Learn best practices

  3. Customize Configuration →

    • Modify skill behavior
    • Configure agents
    • Customize commands

  4. Read FAQ →

    • Common questions
    • Troubleshooting tips

Updating

To update Claude Code Tresor to the latest version:

cd claude-code-tresor

# Pull latest changes
git pull origin main

# Re-run installation
./scripts/update.sh

The update script preserves your customizations while updating utilities.

Uninstallation

To remove Claude Code Tresor:

# Remove skills
rm -rf ~/.claude/skills/code-reviewer
rm -rf ~/.claude/skills/test-generator
rm -rf ~/.claude/skills/git-commit-helper
rm -rf ~/.claude/skills/security-auditor
rm -rf ~/.claude/skills/secret-scanner
rm -rf ~/.claude/skills/dependency-auditor
rm -rf ~/.claude/skills/api-documenter
rm -rf ~/.claude/skills/readme-updater

# Remove agents
rm -rf ~/.claude/agents/code-reviewer
rm -rf ~/.claude/agents/test-engineer
rm -rf ~/.claude/agents/docs-writer
rm -rf ~/.claude/agents/architect
rm -rf ~/.claude/agents/debugger
rm -rf ~/.claude/agents/security-auditor
rm -rf ~/.claude/agents/performance-tuner
rm -rf ~/.claude/agents/refactor-expert

# Remove commands
rm -rf ~/.claude/commands/scaffold
rm -rf ~/.claude/commands/review
rm -rf ~/.claude/commands/test-gen
rm -rf ~/.claude/commands/docs-gen

# Remove repository
cd ..
rm -rf claude-code-tresor

Getting Help

If you encounter issues:

Last Updated: November 7, 2025 | Version: 2.0.0