Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

overide

Package Overview
Dependencies
Maintainers
0
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

overide

This is a CLI based Code Generation Tool.

  • 0.0.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
24
decreased by-92.21%
Maintainers
0
Weekly downloads
 
Created
Source

Oi-Override

Oi-Override is a lightweight yet powerful CLI tool designed to simplify AI-powered code generation directly within your development workflow. With Oi, 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

  • IDE Agnostic: Oi-Override is designed to work with any IDE, allowing you to seamlessly integrate code generation into your development workflow.
  • AI-Powered Code Generation: Automatically generate code based on embedded prompts in your files, using OpenAI’s API.
  • Live File Monitoring: Continuously monitor your project files for updates and code generation prompts.
  • Simple Prompting Syntax: Use intuitive patterns like //> <// to guide AI in generating or completing code snippets in specific locations.

Usage

Initialize a Project

To initialize Oi-Override in your project, run the following command in your project directory:

oi init

This will create a configuration file and set up Oi to work with your project.

Start Monitoring

Once Oi is initialized, you can start monitoring the project files for code generation prompts:

oi start

Oi will continuously watch the project directory and respond to any prompts it detects.

Insert Prompts for Code Generation

Place prompts in your code files to indicate where Oi should generate code. For example:

//> Generate a function to add two numbers <//

Oi will then generate the required code and insert it directly into the file at the prompt location.

  //- Generate a function to add two numbers
  const function = sum(a, b) {
    return a + b;
  }
  //> Accept the changes (y/n): -//

Based on the user's response, Oi will either keep the changes or discard them.

Generate Dependency Graph - IN DEV

You can generate or update the project dependency graph by running:

oi depend

This will create a `.oi-dependency.json` file that tracks the structure of your project and its dependencies.

Configuration

Oi-Override uses an `oi-config.json` file for customization. You can define the AI service, ignore certain files or directories, and configure other options.

Example configuration:

{
  "ignore": ["node_modules", "*.test.js"],
  "verbose": true
}

Key Options

  • service: The AI backend service to use (e.g., OpenAI Codex, local LLM).
  • ignore: Files or directories to exclude from monitoring.
  • verbose: Enable verbose logging to track detailed operations.

Version 2.0 Plan

  • Project Context Management: Using local parsers we should be able to generate better prompts that require less tokens.
  • Code Format: Switch to using unified diff format to improve code insertion.
  • Multiple File Edit: Oi should be able to edit multiple files at once to execute complex tasks.
  • Script Execution: Oi should be able to write and execute scripts to automate tasks.

Contributing

We welcome contributions from the community! Here’s how you can help:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Submit a pull request and describe your changes.

Feel free to open issues for bugs, feature requests, or general feedback!

Community

Join our Discord community to discuss and collaborate on projects, share ideas, and stay up-to-date with the latest developments in the Oi-Override ecosystem.

License

Oi-Override is licensed under the GNU GPL-2.0 License. See the LICENSE file for more details.


Join the Community!

We’re excited to build Oi-Override into a powerful, flexible tool that enhances developer workflows with the help of AI. Follow the repository, contribute, and help us improve Oi for everyone!

FAQs

Package last updated on 16 Oct 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc