### Install OpenClaw Setup Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Set up OpenClaw after manual installation. ```bash gentle-ai install \ --agent openclaw \ --preset full-gentleman ``` -------------------------------- ### Install Minimal Setup for Cursor Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Perform a minimal setup for the Cursor IDE. ```bash gentle-ai install \ --agent cursor \ --preset minimal ``` -------------------------------- ### Non-Interactive Install Example Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/non-interactive.md Example of a non-interactive installation command with multiple flags set. The platform is auto-detected, and flags are consistent across supported operating systems. ```bash go run ./cmd/gentle-ai install \ --agent claude-code,opencode \ --component engram,sdd,skills \ --skill sdd-apply \ --persona gentleman \ --preset full-gentleman \ --dry-run ``` -------------------------------- ### Install Minimal Setup with Specific Agent Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md Installs a minimal setup focusing on 'claude-code' with basic security. Use this for a streamlined setup with a single, specific agent. ```bash # Memory Only setup, just Claude Code with basic security gentle-ai install --preset minimal --agents claude-code ``` -------------------------------- ### Show Installed Components Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md Displays the current status and list of installed components. This command is useful for verifying your setup. ```bash # Show what's installed gentle-ai status ``` -------------------------------- ### Install GGA Component Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/components.md Installs the GGA binary globally on your machine. Project-level hook setup is not automatic and requires manual execution. ```bash gentle-ai install --component gga ``` -------------------------------- ### Install Gentle AI with Go Source: https://github.com/gentleman-programming/gentle-ai/blob/main/README.md Alternative installation method for any platform with Go 1.24+ installed. ```bash go install github.com/gentleman-programming/gentle-ai/cmd/gentle-ai@latest ``` -------------------------------- ### Dry-run Installation Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Preview the installation plan without applying changes. ```bash gentle-ai install --dry-run \ --agent claude-code,opencode \ --preset full-gentleman ``` -------------------------------- ### Install Full Ecosystem Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Install the full ecosystem for multiple agents with a specific preset. ```bash gentle-ai install \ --agent claude-code,opencode,gemini-cli \ --preset full-gentleman ``` -------------------------------- ### Perform Installation Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/quickstart.md Execute the actual installation of Gentle AI. The installer automatically detects your platform and uses the appropriate package manager (brew, apt, pacman, or dnf) for installation. No flags are needed to specify the OS. ```bash go run ./cmd/gentle-ai install ``` -------------------------------- ### Install Gentle AI with Agents and Preset Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Installs Gentle AI and configures specified agents with a full preset. Use this for initial setup. ```bash brew install gentleman-programming/tap/gentle-ai gentle-ai install --agent claude-code,cursor --preset full-gentleman ``` -------------------------------- ### Install with Specific Components and Skills Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Install a specific agent with selected components and skills, and a custom persona. ```bash gentle-ai install \ --agent claude-code \ --component engram,sdd,skills,context7,persona,permissions \ --skill go-testing,skill-creator,branch-pr,issue-creation \ --persona gentleman ``` -------------------------------- ### Install Pi Packages Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/pi.md Installs various Pi support packages using the `pi install` command. This includes core components and adapters for memory and communication. ```bash pi install npm:gentle-pi pi install npm:gentle-engram pi install npm:pi-mcp-adapter npm exec --yes --package gentle-engram@0.1.4 -- pi-engram init pi install npm:pi-subagents pi install npm:pi-intercom pi install npm:@juicesharp/rpiv-ask-user-question pi install npm:pi-web-access pi install npm:@juicesharp/rpiv-todo pi install npm:pi-btw ``` -------------------------------- ### Initialize and Install GGA per Project Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/components.md Enables GGA for a specific project after global installation. This involves initializing the project and then installing GGA. ```bash gga init gga install ``` -------------------------------- ### Start Pi Agent Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/pi.md Starts the Pi agent in your project. Gentle AI will detect the `pi` binary. ```bash pi ``` -------------------------------- ### Create a 'cheap' profile for all phases Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md This example demonstrates how to create a profile named 'cheap' using a free model for all development phases. It utilizes the `--profile` flag with the format `name:provider/model:tier`. ```bash gentle-ai sync --profile cheap:openrouter/qwen/qwen3-30b-a3b:free ``` -------------------------------- ### Launch Installer Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/opencode-profiles.md Run the `gentle-ai` installer from the command line to begin creating a new profile. Alternatively, use `go run ./cmd/gentle-ai`. ```bash gentle-ai ``` ```bash go run ./cmd/gentle-ai ``` -------------------------------- ### Valid Description Example Source: https://github.com/gentleman-programming/gentle-ai/blob/main/internal/assets/skills/skill-creator/SKILL.md A good example of a skill description. It is concise, on a single line, and starts with essential trigger words. ```yaml description: "Trigger: Jira task, ticket, issue, task creation. Create Jira tasks in the team format." ``` -------------------------------- ### Conventional Commit Examples Source: https://github.com/gentleman-programming/gentle-ai/blob/main/internal/assets/skills/branch-pr/SKILL.md Examples demonstrating various conventional commit types and scopes. Use these as a guide when writing your commit messages. ```git feat(scripts): add Codex support to setup.sh ``` ```git fix(skills): correct topic key format in sdd-apply ``` ```git docs(readme): update multi-model configuration guide ``` ```git refactor(skills): extract shared persistence logic ``` ```git chore(ci): add shellcheck to PR validation workflow ``` ```git perf(scripts): reduce setup.sh execution time ``` ```git style(skills): fix markdown formatting ``` ```git test(scripts): add setup.sh integration tests ``` ```git ci(workflows): add branch name validation ``` ```git revert: undo broken setup change ``` ```git feat!: redesign skill loading system ``` -------------------------------- ### Gentle AI Installation Flow Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md This diagram illustrates the step-by-step process for installing Gentle AI, from downloading the binary to final configuration and readiness. ```text curl -sL get.gentleman.ai/ai | sh │ ▼ ┌─────────────────────┐ │ Download binary │ │ (detect OS/arch) │ └──────────┬──────────┘ │ ▼ ┌─────────────────────────────────┐ │ TUI: Welcome │ │ "Gentleman AI Ecosystem" │ │ Supercharge your AI agents. │ └──────────┬──────────────────────┘ │ ▼ ┌─────────────────────────────────┐ │ System Scan │ │ Detected: Claude Code ✓ │ │ OpenCode ✓ │ │ Cursor ✗ │ │ Engram ✗ │ │ OS: macOS (Apple Silicon) │ └──────────┬──────────────────────┘ │ ▼ ┌─────────────────────────────────┐ │ Select AI Agents │ ← Shows detected (pre-checked) + available │ ☑ Claude Code (installed) │ │ ☑ OpenCode (installed) │ │ ☐ Gemini CLI │ │ ☐ Cursor │ │ ☐ VSCode (Copilot/Cline) │ │ ... │ └──────────┬──────────────────────┘ │ ▼ ┌─────────────────────────────────┐ │ Choose your Persona │ │ │ │ ★ "Your own Gentleman!" │ ← Senior Architect mentor, teaches, │ The mentor who pushes you │ challenges, Rioplatense Spanish │ to understand before coding. │ │ │ │ ○ Neutral │ ← No persona, default agent behavior │ ○ Custom │ ← Bring your own persona text └──────────┬──────────────────────┘ │ ▼ ┌─────────────────────────────────┐ │ Select Ecosystem Preset │ │ │ │ ★ Dev Stack + Polish │ ← Everything: Engram + SDD + Skills │ (Engram + SDD + All Skills │ + MCP + Theme + Permissions │ + MCP + Theme) │ │ │ │ ○ Dev Stack │ ← Tools without persona │ ○ Memory Only │ ← Just Engram + basics │ ○ Custom │ ← Pick each component └──────────┬──────────────────────┘ │ ┌───────┴───────┐ │ If "Custom": │ │ ▼ │ ┌──────────────────────┐ │ │ ☑ Engram (memory) │ │ │ ☑ SDD (workflow) │ │ │ ☑ GGA (code review) │ │ │ Select Skills... │ │ │ Select MCP servers...│ │ │ Select Theme... │ │ └────────┬─────────────┘ │ │ └───────┬───┘ │ ▼ ┌─────────────────────────────────┐ │ Review & Confirm │ │ │ │ Agents: Claude Code, OpenCode │ │ Persona: Gentleman │ │ Memory: Engram ✓ │ │ Workflow: SDD (9 skills) ✓ │ │ Code Review: GGA (claude) ✓ │ │ Coding Skills: 15 skills ✓ │ │ MCP: Context7, Notion ✓ │ │ Theme: Gentleman Dark ✓ │ │ │ │ [Install] [Back] │ └──────────┬──────────────────────┘ │ ▼ ┌─────────────────────────────────┐ │ Configuring... │ │ │ │ ✓ Installing Engram │ │ ✓ Installing GGA │ │ ✓ Configuring Claude Code │ │ ✓ Skills (22 files) │ │ ✓ MCP servers │ │ ✓ Engram plugin │ │ ✓ Permissions & theme │ │ ✓ Configuring GGA (claude) │ │ ◌ Configuring OpenCode... │ │ [████████░░] 80% │ └──────────┬──────────────────────┘ │ ▼ ┌─────────────────────────────────┐ │ Done! Your AI agents are ready. │ │ │ │ Next steps: │ │ 1. Set API keys (see below) │ │ 2. Try: claude "hello" │ │ │ │ For larger features, the agent │ │ will automatically offer SDD │ │ (Spec-Driven Development) to │ │ plan and implement step by step.│ │ │ │ Agents configured: 2 │ │ Skills installed: 22 │ │ Memory: Engram running ✓ │ └─────────────────────────────────┘ ``` -------------------------------- ### Install a New Agent Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/usage.md Adds a new agent to your Gentle AI setup with a specified preset. Use this when integrating additional agents. ```bash gentle-ai install --agent windsurf --preset full-gentleman ``` -------------------------------- ### Example: Requesting a Change in a PR Source: https://github.com/gentleman-programming/gentle-ai/blob/main/internal/assets/skills/comment-writer/SKILL.md Use this format to request a change in a Pull Request, starting with a direct observation and providing a brief explanation. ```markdown Good approach overall. I'd split this into a separate commit because it mixes validation logic with UI wiring. That keeps the reviewer's focus narrower and makes rollback cleaner if the integration fails. ``` -------------------------------- ### Quick Start for E2E Tests Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/docker-e2e-testing.md Commands to run E2E tests with different tiers enabled. ```bash # Run Tier 1 only (basic binary + dry-run tests) ./e2e/docker-test.sh ``` ```bash # Run all tiers RUN_FULL_E2E=1 RUN_BACKUP_TESTS=1 ./e2e/docker-test.sh ``` -------------------------------- ### Install Gentle AI using Go install Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md Installs the latest version of Gentle AI using the Go toolchain. Requires Go to be installed. ```bash go install github.com/Gentleman-Programming/gentle-ai/cmd/gentle-ai@latest ``` -------------------------------- ### Repair Failed Installation Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md Attempts to repair a previously failed installation. Use this command when encountering issues after an installation attempt. ```bash # Repair failed installation gentle-ai repair ``` -------------------------------- ### Skill Loading Contract Example Source: https://github.com/gentleman-programming/gentle-ai/blob/main/docs/skill-registry.md Shows the format for specifying skills to load before work, emphasizing the use of exact SKILL.md file paths. ```markdown ## Skills to load before work Read these exact files before reading, writing, reviewing, testing, or creating artifacts: - /path/to/skills/go-testing/SKILL.md - /path/to/skills/docs-writer/SKILL.md ``` -------------------------------- ### Install Gentle AI using winget (Windows) Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md Installs Gentle AI on Windows using the winget package manager. This is a lower priority installation method. ```bash winget install gentle-ai ``` -------------------------------- ### Dependency Tree Visualization Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md This is a visual representation of the dependency tree shown to the user before installation. It indicates which dependencies are already installed, which will be installed, and which are needed by specific components. ```text ┌──────────────────────────────────────────────────────────────────┐ │ DEPENDENCY TREE (shown to user before install) │ │ │ │ Base tools: │ ✓ git (already installed: 2.43.0) │ │ ✓ curl (already installed) │ │ ✓ bash (already installed: 5.2) │ │ ◌ Homebrew (will install) │ │ │ │ Runtimes (needed by selected agents): │ ◌ Node.js 20 (needed by: Claude Code, Gemini CLI) │ │ ✓ Go 1.25 (already installed — not needed for binary installs)│ │ │ │ AI Agents: │ ◌ Claude Code (via npm) │ │ ◌ OpenCode (native binary) │ │ │ │ Ecosystem: │ ◌ Engram (via Homebrew — no runtime deps) │ │ ◌ GGA (via Homebrew — needs bash + git + provider CLI) │ │ ◌ SDD skills (file copy — no deps) │ │ ◌ Skills library (file copy — no deps) │ └──────────────────────────────────────────────────────────────────┘ ``` -------------------------------- ### Install Gentle AI with Scoop Source: https://github.com/gentleman-programming/gentle-ai/blob/main/README.md Recommended installation for Windows using Scoop. Requires adding the custom Scoop bucket first. ```powershell # Windows scoop bucket add gentleman https://github.com/Gentleman-Programming/scoop-bucket scoop install gentle-ai ``` -------------------------------- ### Sub-Agent Skill Loading Instruction Example Source: https://github.com/gentleman-programming/gentle-ai/blob/main/internal/assets/gemini/sdd-orchestrator.md Shows how to instruct a sub-agent to load specific skill paths before commencing its task. ```text ## Skills to load before work Instruct the sub-agent to read those exact files BEFORE task-specific work ``` -------------------------------- ### Install Gentle AI Beta on Windows Source: https://github.com/gentleman-programming/gentle-ai/blob/main/README.md Installs the beta version of Gentle AI from the main branch on Windows using PowerShell. Requires Go 1.24+. ```powershell $env:GENTLE_AI_CHANNEL="beta"; irm https://raw.githubusercontent.com/Gentleman-Programming/gentle-ai/main/scripts/install.ps1 | iex ``` -------------------------------- ### Install Gentleman AI Ecosystem Source: https://github.com/gentleman-programming/gentle-ai/blob/main/PRD.md Installs the Gentleman AI ecosystem configurator. This command fetches and executes the installation script, allowing users to then select their preferred AI agent and configuration. ```bash curl -sL get.gentleman.ai/ai | sh ```