cli

Development Documentation

Guides for developing and contributing to Shep AI CLI.

Contents

Document	Description
setup.md	Development environment setup
tdd-guide.md	TDD methodology with Clean Architecture
spec-driven-workflow.md	Shep-kit spec-driven development flow
implementation-guide.md	Implementation discipline and patterns
testing.md	Testing strategy and commands
building.md	Build process and tooling
cicd.md	CI/CD pipeline and Docker setup
typespec-guide.md	TypeSpec domain modeling guide
adding-agents.md	Adding new LangGraph agent nodes
feature-yaml-protocol.md	feature.yaml status tracking protocol
web-component-library.md	Web UI component library reference
shep-kit-reference.md	Shep-kit skills complete reference

Quick Start for Contributors

# Clone repository
git clone https://github.com/shep-ai/cli.git
cd cli

# Install dependencies
pnpm install

# Build
pnpm build

# Run tests
pnpm test

# Start CLI in development mode
pnpm dev:cli

# Start Web UI in development mode
pnpm dev:web

Development Workflow

1. Setup - Configure your development environment
2. Branch - Create a feature branch from main
3. Develop - Write code following architecture guidelines
4. Test - Ensure all tests pass
5. Lint - Check code style
6. Commit - Use conventional commits
7. PR - Open pull request for review

Key Guidelines

• Follow Clean Architecture principles
• Write tests for new functionality (TDD mandatory)
• Keep commits atomic and well-described
• Update documentation for user-facing changes
• All features start with /shep-kit:new-feature

Related Documents

• CONTRIBUTING.md - Contribution guidelines
• Architecture docs - System design
• CLAUDE.md - AI tooling guidance

---

Maintaining This Directory

Update when:

• Development workflow changes
• New tooling is adopted
• Setup process changes

File naming:

• Use kebab-case
• Be descriptive
• Match process names

This site is open source. Improve this page.