overide

Overide

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.

Table of Contents

• 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

Key Features

• 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

Installation

Install globally using npm or pnpm:

npm install -g overide
# or
pnpm install -g overide

For more installation options, see our installation guide.

Usage

Adding API Key

Configure your OpenAI credentials:

overide config --global

Configure a Project

Configure Overide in your project directory:

overide init

Start Monitoring

Begin monitoring files for code generation:

overide start

Code Generation

Insert prompts in your code:

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

Overide will generate and insert code:

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

Configuration

Configure Overide using oi-config.json:

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

Contributing

Development Workflow

• Clone the repository (if you haven't already)

• Create feature branches from dev

• Make changes and test thoroughly

• Create PR to merge into dev

• If approved, create PR to merge dev into staging

• If staging tests pass, create PR to merge staging into main

• When merged to main:

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

Version Management with Changesets

We use changesets for version management.

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

• Create a changeset:

pnpm changeset

• 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 to main:

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

Change Types

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

Development & Testing

Local Development (Hot Reloading)

• Start the development watcher:

npm run dev
# or
pnpm dev

• In a separate terminal, run the CLI commands as you normally would, with npm run or pnpm prefixed:

npm run overide [init | config | start]
# or
pnpm 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.

Local Production Testing

• Build and create global link:

npm run build
npm link

• Link in test project:

npm link -g overide

• Test the production version of the CLI:

overide --version
overide init
overide start

• Cleanup:

# In test project
npm unlink -g overide

# In Overide project
npm unlink

Why Development Testing?

• 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

Why Link Testing?

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

CI/CD Pipeline

The project uses GitHub Actions for continuous integration and deployment:

• CI/CD Pipeline (pipeline.yml)

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

• Publish Workflow (publish.yml)

  • Triggers on pushes to main when changes are detected in:

    • .changeset/**
    • package.json

  • Uses changesets for version management

  • Publishes to npm when changes are detected

  • Syncs changes back to staging branch

Future Plans (v2.0)

• 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

Community

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

License

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

Changelog

1.0.0

Major Changes

• 8f7ee3b: This change removes all other platform support besides OpenAI, as well as some code refactoring.

Minor Changes

• 924d737: Now we are able to use response_format in case of OpenAi api
• 448b40e: Rollback: Embeddings and Dependency graph support.

Patch Changes

• f3e5e61: Added support for --path option in init and start commands. This allows user to initialise and start overide in any target path on a system.