A CLI tool powered by Claude 3 that helps with coding tasks.
- Node.js 18 or higher
- An Anthropic API key
- Clone this repository
- Install dependencies:
npm install
- Set up your Anthropic API key:
export ANTHROPIC_API_KEY=your-api-key
Run the CLI with:
npm run build
node dist/cli.js [options]
-p, --path <directory>
: Project root directory path (default: current working directory)-i, --instruction <file>
: Path to instruction file-e, --entry <file>
: Entry point file path
- Create an instruction file
task.txt
:
Please refactor the User class in src/models/user.ts to use TypeScript interfaces
- Run the CLI:
npm run build
node dist/cli.js -p ./my-project -i task.txt -e src/models/user.ts
# or
./bin/mini-coder
-p, --path <directory>
- Specify project root directory path (default: current working directory)-i, --instruction <file>
- Path to instruction file (required)-e, --entry <file>
- Entry point file path (optional)
# Run with instruction file using current directory
mini-coder -i instruction.txt
# Run with custom project directory
mini-coder -p /path/to/project -i instruction.txt
# Run with entry point file
mini-coder -p /path/to/project -i instruction.txt -e src/index.ts
The CLI performs these validations:
- Verifies the project directory exists and is a valid directory
- If provided, verifies the entry point file exists
- Checks that the instruction file can be read
The tool automatically configures an MCP filesystem server pointing to the specified project directory for file access.
If any validation fails, the program will exit with an error message explaining the issue.
- Open the GitHub issue create page: New Issue
- Add the following details in the issue body to report the design:
- Once the issue is created, start working on the design implementation.
- Reference the issue number in the commit messages to link the implementation with the issue.
Make sure to review and merge the design implementation into the main branch and close the issue once the implementation is merged.