@neovate/code 0.0.0-alpha.0 → 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-present ChenCheng (sorrycc@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# Neovate
+
+[![](https://badgen.net/npm/v/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
+[![](https://badgen.net/npm/dm/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
+[![](https://github.com/neovateai/code/actions/workflows/ci.yml/badge.svg)](https://github.com/neovateai/code/actions/workflows/ci.yml)
+[![](https://badgen.net/npm/license/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
+
+A coding agent to enhance your development workflow.
+
+## Getting Started
+
+> Make sure you have Node.js version 18 or higher installed.
+
+1. **Install the CLI globally.** Use npm or other package managers.
+
+```bash
+$ npm install -g @neovate/code
+```
+
+2. **Set up the API keys.** Configure one or more API keys for the LLMs providers.
+
+```bash
+$ export OPENAI_API_KEY="sk-..."
+$ export GOOGLE_API_KEY="sk-..."
+$ export ANTHROPIC_API_KEY="sk-..."
+$ export DEEPSEEK_API_KEY="sk-..."
+$ export XAI_API_KEY="sk-..."
+$ export AIHUBMIX_API_KEY="sk-..."
+$ export OPENROUTER_API_KEY="sk-..."
+```
+
+You are now ready to use Neovate.
+
+```bash
+$ neovate
+> explain this codebase to me
+```
+
+## Contributing
+
+Contributions are welcome! Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on setting up the development environment, running tests, and submitting pull requests.
+
+## License
+
+[MIT](./LICENSE)