@every-env/cli
Advanced tools
Tools for AI-powered development that get smarter with every use. Make each unit of engineering work easier than the last.
Compounding engineering: Each unit of engineering work should make subsequent units of work easier—not harder.
Every-Env embodies this principle through a simple, repeatable process that ensures your development workflow continuously improves.
┌─────────────┐ ┌──────────────┐ ┌─────────────┐ ┌─────────────┐
│ Plan │────▶│ Delegate │────▶│ Assess │────▶│ Codify │
│ Plan it out │ │ Do the work │ │ Make sure │ │ Record │
│ in detail │ │ │ │ it works │ │ learnings │
└─────────────┘ └──────────────┘ └─────────────┘ └─────────────┘
▲ │
└──────────────────────────────────────────────────────────────┘
Plan → Plan out a feature or bug fix in detail
Delegate → Do the work
Assess → Make sure it works as expected
Codify → Record learnings for next time
Every-Env is opinionated about the process (Plan → Delegate → Assess → Codify) but works with whatever tools you already use:
The four-step process works regardless of your toolchain. Every-Env provides the structure; you bring the tools.
Before using every-env, you need to have Claude Code installed:
npm install -g @anthropic-ai/claude-code
Verify installation:
claude --version
npm install -g @every-env/cli
For project-specific installation:
npm install --save-dev @every-env/cli
Every-Env provides a comprehensive CLI that directly implements the four-step compounding engineering process.
# Core initialization
every-env init # Initialize every-env in your project
# The Four Steps of Compounding Engineering
every-env plan <task> # Step 1: PLAN - Create detailed implementation plans
every-env work [plan] # Step 2: DELEGATE - Execute with AI assistance
every-env review [target] # Step 3: ASSESS - Verify work meets requirements
every-env codify # Step 4: CODIFY - Record learnings permanently
# Supporting commands
every-env request-review # Get team feedback during assessment
every-env revise [target] # Iterate on plans based on feedback
# Documentation workflow
every-env docs update # Update documentation
every-env docs run <pattern> # Run specific documentation patterns
every-env docs list # List available patterns
every-env docs status # Check documentation status
Available for all commands:
-c, --config <path> - Configuration file path (default: .docs-config.json)-p, --parallel <number> - Max parallel agents--dry-run - Preview without executing-v, --verbose - Verbose output--debug - Debug outputinit CommandInitialize every-env in your project. This is your starting point for all workflows.
every-env init # Interactive setup
every-env init --template rails # Use Rails template
every-env init --template node # Use Node.js template
every-env init --force # Force regeneration
every-env init --dry-run # Preview what would be created
Creates project structure:
.docs-config.json - Main configurationprompts/ - Prompt templates directory.every-env/ - State and metadata directory.gitignore entries for generated filesDetects project type and suggests appropriate templates
Runs initial generation of all configured patterns
Templates provide pre-configured setups for common project types:
docs)The documentation workflow automates the creation and maintenance of project documentation using AI.
every-env docs updateUpdate existing documentation based on code changes.
every-env docs update # Update all patterns
every-env docs update --pattern api # Update specific pattern
every-env docs update --force # Force regeneration
every-env docs update --since HEAD~3 # Update based on git changes
every-env docs run <pattern>Run a specific documentation pattern.
every-env docs run api-docs # Run single pattern
every-env docs run models controllers # Run multiple patterns
every-env docs run dependencies --only axios # Process specific matches
every-env docs listList all available documentation patterns.
every-env docs list # Show all patterns
every-env docs list --verbose # Include pattern details
Output example:
Available patterns:
api - API endpoint documentation
models - Database model documentation
deps - Dependency analysis
every-env docs statusShow the status of documentation generation.
every-env docs status # Current status
every-env docs status --detailed # Include file-level details
The planning workflow represents the full development lifecycle, from ideation to implementation to learning.
every-env plan [patterns...]Generate AI-powered implementation plans, work breakdowns, and technical designs using pattern-based workflows.
# List available planning patterns
every-env plan --list
# Generate an implementation plan
every-env plan implementation-plan
# Create multiple planning documents
every-env plan implementation-plan work-breakdown technical-design
# Use custom output directory
every-env plan implementation-plan --output plans/sprint-1
# Preview what would be created
every-env plan technical-design --dry-run
implementation-plan - Comprehensive implementation plan from requirements
work-breakdown - Work Breakdown Structure (WBS)
technical-design - Detailed technical design document
Plans are generated in the specified output directory (default: plans/):
plans/implementation-plan-analysis.mdplans/work-breakdown-wbs.mdplans/technical-design-design.md-o, --output <path> - Output directory for plan files (default: "plans")-t, --template <name> - Specific plan template to use--timeline - Include timeline in plans (default: true)--resources - Include resource estimates (default: true)--tasks - Break down into detailed tasks (default: true)-l, --list - List available patternsevery-env review [target]Review plans, pull requests, or GitHub issues to provide constructive feedback.
# Review the latest plan
every-env review
# Review a specific plan
every-env review plans/2024-01-15-signup-button.md
# Review a GitHub issue
every-env review --github 1234
# Review a pull request
every-env review --github 444
.every-env/state.jsonReviews are added as markdown comments in the plan file:
<!-- REVIEW: 2024-01-15T14:30:00Z
Strengths:
- Clear user story definition
- Good consideration of edge cases
Suggestions:
- Consider accessibility requirements for the button
- Add performance metrics for form submission
-->
every-env request-review <target> --from <reviewer>Request feedback from team members on plans or pull requests.
# Request review on a plan
every-env request-review plans/2024-01-15-signup.md --from @kieranklaassen
# Request review on a GitHub PR
every-env request-review --github 444 --from @teammate
# Request review from multiple reviewers
every-env request-review plans/api-refactor.md --from @alice,@bob
every-env revise [target] [feedback]Improve plans based on review feedback.
# Revise latest plan using embedded review comments
every-env revise
# Revise specific plan
every-env revise plans/2024-01-15-signup.md
# Revise with feedback file
every-env revise plans/2024-01-15-signup.md feedback.md
# Revise with inline feedback
every-env revise plans/2024-01-15-signup.md "make it more user-friendly"
# Revise based on GitHub PR comments
every-env revise --github 444
every-env work [plan]Start development with AI assistance, using a plan as context.
# Work on the latest plan
every-env work
# Work on a specific plan
every-env work plans/2024-01-15-signup.md
# Work from a GitHub issue
every-env work --github 1234
# Work with additional context
every-env work --context architecture.md
The AI assistant receives:
every-env codifyCapture learnings from completed work and update project knowledge.
# Codify learnings from recent work
every-env codify
# Codify specific plans
every-env codify plans/2024-01-15-signup.md
# Codify with specific insights
every-env codify --insight "always validate email format client-side"
# Dry run to preview changes
every-env codify --dry-run
Each codification creates a migration in .every-env/migrations/:
2024-01-15-signup-patterns.md
2024-01-14-auth-improvements.md
2024-01-13-api-structure.md
Every-Env automatically tracks your development workflow in .every-env/state.json:
{
"activePlans": [
{
"id": "2024-01-15-signup-button",
"path": "plans/2024-01-15-signup-button.md",
"created": "2024-01-15T10:30:00Z",
"status": "in-review",
"revisions": 2,
"lastModified": "2024-01-15T14:30:00Z"
}
],
"latestPlan": "2024-01-15-signup-button",
"reviewRequests": [
{
"plan": "2024-01-15-signup-button",
"reviewer": "@kieranklaassen",
"requested": "2024-01-15T11:00:00Z",
"status": "pending"
}
],
"codification": {
"lastCodified": "2024-01-14T18:30:00Z",
"migrations": [
"2024-01-14-auth-patterns",
"2024-01-13-api-structure"
]
}
}
This enables:
Every-Env uses a flexible JSON-based configuration system.
The configuration file (.docs-config.json) defines patterns and agents:
{
"defaultCommand": "claude",
"parallelism": {
"maxAgents": 5
},
"patterns": [
{
"name": "api",
"description": "API endpoint documentation",
"match": {
"files": ["app/controllers/**/*.rb"],
"exclude": ["**/*_test.rb"]
},
"agents": [
{
"id": "api-docs",
"promptFile": "prompts/api.md",
"output": "docs/api.md"
}
]
}
]
}
🎉 Good news: Essential file operation tools are now automatically included for all agents:
Read, Write, Edit, MultiEdit - File operationsGlob, Grep, LS - File discovery and searchYou can add additional tools as needed:
{
"defaultAllowedTools": [
// Additional tools beyond the essentials
"WebSearch",
"WebFetch", // For research
"Bash(git log:*)",
"Bash(git diff:*)", // Git integration
"Bash(npm list:*)",
"Bash(bundle show:*)" // Package info
]
}
See allowed-tools-guide.md for comprehensive tool reference.
Target specific files and extract content:
{
"patterns": [
{
"name": "dependencies",
"match": {
"files": ["package.json"],
"content": {
"regex": "\"([^\"]+)\": \"[^\"]+\"",
"captureGroup": 1,
"exclude": ["@types/*"]
}
},
"agents": [
{
"id": "dep-docs",
"promptFile": "prompts/dependency.md",
"outputPattern": "docs/deps/{name}.md",
"forEach": "match"
}
]
}
]
}
Use variables in your prompts:
{
"variables": {
"company": "Acme Corp",
"framework": "Rails"
},
"patterns": [...]
}
Access in prompts:
# {{ company }} - {{ framework }} Application
Generated on {{ date }} from branch {{ gitBranch }}
projectName - Derived from package.json or directory nametimestamp - ISO timestampdate - Formatted dategitBranch - Current git branchgitCommit - Current commit hashgitAuthor - Git user nameoutput - Output file pathoutputDir - Output directoryoutputName - Output filenamename - Current match value (when using forEach)index - Current match indextotal - Total matchesHere's how the four steps of compounding engineering work in practice:
# Step 1: PLAN - Create a detailed implementation plan
every-env plan "add user authentication with OAuth"
# Creates: plans/2024-01-15-oauth-auth.md
# Step 2: DELEGATE - Execute the plan with AI assistance
every-env work
# Launches Claude Code with the plan as context
# Step 3: ASSESS - Verify everything works correctly
every-env review
# Reviews the implementation against the plan
# Optional: Get team feedback
every-env request-review --from @teammate
# Step 4: CODIFY - Record what you learned
every-env codify
# Updates CLAUDE.md with new patterns and learnings
# Ensures this knowledge helps future work
Each cycle through these four steps makes the next cycle easier and more efficient.
# Initialize with Rails template
every-env init --template rails
# Generate all documentation
every-env docs update
# Plan a new feature
every-env plan "add admin dashboard"
# Start working
every-env work
# Initialize with Node template
every-env init --template node
# Document dependencies
every-env docs run dependencies
# Plan API improvements
every-env plan "add rate limiting to API endpoints"
{
"patterns": [
{
"name": "architecture",
"match": {
"files": ["src/**/*.ts", "src/**/*.js"]
},
"agents": [
{
"id": "arch-docs",
"promptFile": "prompts/architecture.md",
"output": "docs/ARCHITECTURE.md"
}
]
}
]
}
DOCS_MAX_AGENTS - Override maximum parallel agentsCLAUDE_SKIP_PERMISSIONS - Skip Claude permission checksEVERY_ENV_STATE_DIR - Custom state directory locationEVERY_ENV_CONFIG - Default config file path# Clone the repository
git clone https://github.com/every-env/every-env.git
cd every-env
# Install dependencies
npm install
# Run in development mode
npm run dev
# Run tests
npm test
# Build for production
npm run build
Contributions are welcome! Please read our Contributing Guide for details.
MIT © Every Env
FAQs
Multi-agent orchestrator for AI-powered development workflows
The npm package @every-env/cli receives a total of 6 weekly downloads. As such, @every-env/cli popularity was classified as not popular.
We found that @every-env/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Newly published Trivy Docker images (0.69.4, 0.69.5, and 0.69.6) were found to contain infostealer IOCs and were pushed to Docker Hub without corresponding GitHub releases.
Research
/Security News
The worm-enabled campaign hit @emilgroup and @teale.io, then used an ICP canister to deliver follow-on payloads.
Research
/Security News
Attackers compromised Trivy GitHub Actions by force-updating tags to deliver malware, exposing CI/CD secrets across affected pipelines.