Repository files navigation

Overide is a lightweight yet powerful CLI tool designed to simplify AI-powered code generation directly within your development workflow. With Overide, you can quickly generate, update, and integrate code using predefined prompts, allowing you to focus on the creative aspects of coding while letting AI handle the heavy-lifting.

• Key Features
• Installation
• Usage
  • Adding API Key
  • Configure a Project
  • Start Monitoring
  • Code Generation
• Configuration
• Contributing
  • Development Workflow
  • Version Management with Changesets
  • Development Testing
• Future Plans (v2.0)
• Community
• License

• IDE Agnostic: Works with any IDE or text editor
• AI-Powered Code Generation: Uses OpenAI API
• Live File Monitoring: Continuously monitors files for code generation prompts
• Simple Prompting Syntax: Uses intuitive//> <// patterns for code generation

Install globally using npm or pnpm:

npm install -g overide# orpnpm install -g overide

For more installation options, see ourinstallation guide.

Configure your OpenAI credentials:

overide config --global

Configure Overide in your project directory:

overide init

Begin monitoring files for code generation:

overide start

Insert prompts in your code:

//> Generate a function that logs 'Hello, World!' <//

Overide will generate and insert code:

//- 'Hello, World!' FunctionfunctionhelloWorld(){console.log("Hello, World!");}//> Accept the changes (y/n): -//

Configure Overide usingoi-config.json:

{"name":"project name","ignore": ["node_modules","*.test.js"]}

1. Clone the repository (if you haven't already)

2. Create feature branches fromdev

3. Make changes and test thoroughly

4. Create PR to merge intodev

5. If approved, create PR to mergedev intostaging

6. If staging tests pass, create PR to mergestaging intomain

7. When merged tomain:

   • Changes trigger the CI/CD pipeline
   • If changesets are present, a new version is published
   • Changes are automatically synced back to thestaging anddev branches

We usechangesets for version management.

Before submitting a PR from your feature branch, do the following:

1. Create a changeset:

pnpm changeset

2. Follow the prompts to:

   • Select change type (patch/minor/major)
   • Describe your changes
   • Commit both your changes and the generated changeset file

When changes with changesets are merged tomain:

• Package is automatically published to npm
• Changes are synced tostaging branch
• Changelog is automatically updated

• patch: Bug fixes and minor updates (0.0.X)
• minor: New features (0.X.0)
• major: Breaking changes (X.0.0)

1. Start the development watcher:

npm run dev# orpnpm dev

2. In a separate terminal, run the CLI commands as you normally would, withnpm run orpnpm prefixed:

npm run overide [init| config| start]# orpnpm overide [init| config| start]

The development watcher (npm run dev) will automatically rebuild the project when you make changes to the source code, allowing you to test changes in real-time.

1. Build and create global link:

npm run buildnpm link

2. Link in test project:

npm link -g overide

3. Test the production version of the CLI:

overide --versionoveride initoveride start

4. Cleanup:

# In test projectnpm unlink -g overide# In Overide projectnpm unlink

• Hot Reload: Test changes instantly without manual rebuilds
• Real-time Feedback: See immediate results of code modifications
• Faster Development: Reduce time between changes and testing
• Debugging: Easier to identify and fix issues during development

• Test CLI as if installed globally
• Verify changes before publishing
• Validate package.json bin configuration
• Ensure proper dependency inclusion

The project uses GitHub Actions for continuous integration and deployment:

1. CI/CD Pipeline (pipeline.yml)

   • Runs on PRs to any branch and pushes tomain
   • Installs dependencies with pnpm
   • Runs linting checks
   • Builds the project
   • Creates release pull requests when onmain

2. Publish Workflow (publish.yml)

   • Triggers on pushes tomain when changes are detected in:

     • .changeset/**
     • package.json

   • Uses changesets for version management

   • Publishes to npm when changes are detected

   • Syncs changes back tostaging branch

• Project Context Management: Local parsers for more efficient prompts
• Code Format: Unified diff format for improved insertion
• Multiple File Edit: Support for multi-file operations
• Script Execution: Automated task execution capabilities

Join ourDiscord to collaborate, share ideas, and stay updated with Overide developments.

Overide is licensed under the GNU GPL-2.0 License. See theLICENSE file for details.