Skip to content

claude-code-quickstart.md

Latest commit

 

History

History
202 lines (134 loc) · 4.78 KB

claude-code-quickstart.md

File metadata and controls

202 lines (134 loc) · 4.78 KB

Claude Code Quick Start

Install & Deploy

Option A: Plugin (Recommended)

Native Claude Code integration - no npm required:

# Add AIWG marketplace (one-time)
/plugin marketplace add jmagly/ai-writing-guide
# Install the frameworks you need
/plugin install sdlc@aiwg        # Full SDLC framework
/plugin install marketing@aiwg   # Full marketing framework
/plugin install utils@aiwg       # Core utilities
/plugin install voice@aiwg       # Voice profiles

No account required - Plugin distribution is decentralized. No registry signup, no approval process - just add and install from any git repository.

Option B: npm + CLI

For CLI tools and multi-platform deployment:

# Install CLI
npm install -g aiwg

# Deploy to your project
cd /path/to/your/project
aiwg use sdlc

After Installation

1. Open your project in Claude Code

claude .

2. Integrate with platform context

/aiwg-setup-project

3. Regenerate for natural language support

/aiwg-regenerate-claude

This enables natural language command mapping ("run security review" → workflow). Without it, advanced features won't work correctly.

4. You're ready. See the Intake Guide for starting projects.

What Gets Created

.claude/
├── agents/      # SDLC agents (Requirements Analyst, Architecture Designer, etc.)
├── commands/    # Slash commands (/project-status, /security-gate, etc.)
├── skills/      # Skill directories (voice profiles, project awareness, etc.)
└── rules/       # Context rules (token security, citation policy, etc.)

CLAUDE.md        # Project context
.aiwg/           # SDLC artifacts

Claude Code deploys all 4 artifact types natively: agents, commands, skills, and rules.

Troubleshooting

Plugin Issues

Marketplace not loading?

# Verify marketplace was added
/plugin marketplace list

# Re-add if missing
/plugin marketplace add jmagly/ai-writing-guide

Plugin installation fails?

# Check available plugins
/plugin search @aiwg

# Verify plugin exists
/plugin info sdlc@aiwg

Files not found after installation?

Plugins are copied to a cache directory. If you see missing file errors:

# Reinstall the plugin
/plugin uninstall sdlc@aiwg
/plugin install sdlc@aiwg

Update plugins to latest version?

# Update marketplace catalog
/plugin marketplace update

# Reinstall for latest
/plugin uninstall sdlc@aiwg
/plugin install sdlc@aiwg

General Issues

Natural language not working?

/aiwg-regenerate-claude

Commands/agents missing?

# npm method
aiwg use sdlc

# or reinstall plugin
/plugin install sdlc@aiwg

Check installation:

aiwg version

Context Window Defaults

AIWG-launched Claude sessions default CLAUDE_CODE_DISABLE_1M_CONTEXT=1 when the variable is unset. This removes Claude Code's 1M-context model variants from /model for AIWG-launched sessions.

Why: AIWG already manages context with scoped skills, RLM patterns, and compact handoffs. On credit-billed Claude accounts, accidentally selecting a 1M-context variant can spend credits much faster than a bounded 200k session. Subscription accounts can opt back in when large-context work is intentional.

To opt in for an AIWG-launched session, set the variable explicitly before launching:

export CLAUDE_CODE_DISABLE_1M_CONTEXT=0

AIWG preserves any explicit value. Unset means AIWG injects the safe default; 0 means you chose to keep 1M variants available.

Agent Loop

Agent loops support multi-provider execution via --provider:

aiwg ralph "Fix all tests" --completion "npm test passes"
aiwg ralph "Migrate to TS" --completion "tsc passes" --provider codex

See Al Guide for full documentation.

Available Plugins

Plugin Description Install
sdlc@aiwg Full SDLC framework /plugin install sdlc@aiwg
marketing@aiwg Full marketing framework /plugin install marketing@aiwg
utils@aiwg Core utilities, regenerate commands /plugin install utils@aiwg
voice@aiwg Voice profiles for consistent writing /plugin install voice@aiwg
writing@aiwg AI pattern detection, validation /plugin install writing@aiwg
hooks@aiwg Workflow tracing, observability /plugin install hooks@aiwg

MCP Sidecar (AIWG Tooling Layer)

For structured AIWG tool access (artifact management, workflow execution, template rendering), connect the AIWG MCP server:

aiwg mcp install claude

The sidecar complements --dangerously-skip-permissions — use both for the full AIWG experience. See the Claude MCP Sidecar Guide for details.