Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oi-overide/oi
Overide (pronounced over·ide) is a lightweight, yet powerful CLI tool that seamlessly integrates AI-powered code generation into your development workflow. It works platform-agnostically with OpenAI, DeepSeek, and Groq to provide intelligent code updates directly in your preferred code editor - no extensions required.
https://github.com/oi-overide/oi
Last synced: 3 days ago
JSON representation
Overide (pronounced over·ide) is a lightweight, yet powerful CLI tool that seamlessly integrates AI-powered code generation into your development workflow. It works platform-agnostically with OpenAI, DeepSeek, and Groq to provide intelligent code updates directly in your preferred code editor - no extensions required.
- Host: GitHub
- URL: https://github.com/oi-overide/oi
- Owner: oi-overide
- License: gpl-2.0
- Created: 2024-09-26T14:57:53.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T17:58:21.000Z (3 months ago)
- Last Synced: 2024-12-04T09:11:28.768Z (2 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/overide
- Size: 987 KB
- Stars: 103
- Watchers: 5
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-AI-driven-development - oi - an open-source cli tool that works on top of codellama and generates code in any editor without extensions. (Uncategorized / Uncategorized)
README
# 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](#key-features)
- [Installation](#installation)
- [Usage](#usage)
- [Adding API Key](#adding-api-key)
- [Configure a Project](#configure-a-project)
- [Start Monitoring](#start-monitoring)
- [Code Generation](#code-generation)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [Development Workflow](#development-workflow)
- [Version Management with Changesets](#version-management-with-changesets)
- [Development Testing](#development-testing)
- [Future Plans (v2.0)](#future-plans-v20)
- [Community](#community)
- [License](#license)
## Key Features
- **IDE Agnostic**: Works with any IDE or text editor
- **AI-Powered Code Generation**: Uses OpenAI, DeepSeek, or Groq APIs
- **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:
```bash
npm install -g overide
# or
pnpm install -g overide
```
For more installation options, see our [installation guide](https://github.com/Overide/Overide/blob/main/Installation/Installation.md).
## Usage
### Adding API Key
Configure your AI platform credentials:
```bash
overide config --global
```
Select an active platform if you've configured multiple:
```bash
overide config --select-active
```
### Configure a Project
Configure Overide in your project directory:
```bash
overide init
```
### Start Monitoring
Begin monitoring files for code generation:
```bash
overide start
```
### Code Generation
Insert prompts in your code:
```javascript
//> Generate a function that logs 'Hello, World!' /
```
Overide will generate and insert code:
```javascript
//- 'Hello, World!' Function
function helloWorld() {
console.log("Hello, World!");
}
//> Accept the changes (y/n): -//
```
## Configuration
Configure Overide using `oi-config.json`:
```json
{
"name": "project name",
"ignore": ["node_modules", "*.test.js"]
}
```
## Contributing
### Development Workflow
1. Clone the repository (if you haven't already)
2. Create feature branches from `dev`
3. Make changes and test thoroughly
4. Create PR to merge into `dev`
5. If approved, create PR to merge `dev` into `staging`
6. If staging tests pass, create PR to merge `staging` into `main`
7. 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](https://github.com/changesets/changesets) for version management.
Before submitting a PR from your feature branch, do the following:
1. Create a changeset:
```bash
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 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)
1. Start the development watcher:
```bash
npm run dev
# or
pnpm dev
```
2. In a separate terminal, run the CLI commands as you normally would, with `npm run` or `pnpm` prefixed:
```bash
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
1. Build and create global link:
```bash
npm run build
npm link
```
2. Link in test project:
```bash
npm link -g overide
```
3. Test the production version of the CLI:
```bash
overide --version
overide init
overide start
```
4. Cleanup:
```bash
# 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:
1. **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`
2. **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](https://discord.com/invite/Z7F4vRq3n8) to collaborate, share ideas, and stay updated with Overide developments.
## License
Overide is licensed under the GNU GPL-2.0 License. See the [LICENSE](LICENSE) file for details.