cyne-cli
v0.0.32-beta
Published
Use Cyne, Cynerza's AI assistant, right from your terminal. Cyne can understand your codebase, edit files, run terminal commands, and handle entire workflows for you.
Readme
CYNE
Features
- Code Comprehension: Understand complex code with natural language explanations.
- Code Generation: Generate new code or modify existing files with simple prompts.
- Test Generation: Automatically create unit tests for your codebase.
- Shell Command Execution: Run shell commands and scripts directly from the assistant.
- Extensibility: Compatible with any model that supports the OpenAI-style API.
- Interactive Environment: A REPL-like interface for a seamless workflow.
Getting Started
Installation
To install CYNE globally, use the following command:
npm install -g cyneUsage
Navigate to your project directory and run CYNE:
cd your-project
cyneCommands
CYNE supports a variety of slash commands to enhance your workflow:
/model: Select the model you want to use./config: Configure the tool to your preferences./bug: Report a bug or issue./help: Get help with using the tool.
Examples
Explaining a function
/explain "my_function" in my_file.jsGenerating a new component
/new "MyComponent" in src/componentsRunning tests
/run_testsTroubleshooting
If you encounter any issues, try the following:
- Ensure you have a stable internet connection.
- Verify that your API keys are correctly configured.
- Check the CYNE documentation for updates and solutions.
Contributing
We welcome contributions from the community. If you would like to contribute, please:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Commit your changes and open a pull request.
- Ensure your code follows the project's coding standards.
License
CYNE is licensed under the MIT License. See the LICENSE.md file for more details.
