@neovate/code/README.md

A coding agent to enhance your development workflow.

<div align="center">
<img src="https://mdn.alipayobjects.com/huamei_9rin5s/afts/img/0uIJQaelzccAAAAAQCAAAAgADiB8AQFr/original" alt="Neovate Code Logo" width="60" />
<br />
<br />
<img src="https://mdn.alipayobjects.com/huamei_9rin5s/afts/img/UdphTJIBImUAAAAAQKAAAAgADiB8AQFr/original" alt="Neovate Code Logo Text" width="160" />

---

[![](https://img.shields.io/npm/v/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
[![](https://img.shields.io/npm/dm/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
[![](https://github.com/neovateai/neovate-code/actions/workflows/test.yml/badge.svg)](https://github.com/neovateai/neovate-code/actions/workflows/test.yml)
[![](https://img.shields.io/npm/l/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
[![](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-blue)](https://www.npmjs.com/package/@neovate/code)

**Neovate**, pronounced as `['niːəʊveɪt]`, is a **coding agent** to enhance your development workflow. You can use it to generate code, fix bugs, review code, add tests, and more.

✨ See more at [neovateai.dev](https://neovateai.dev).

![](https://mdn.alipayobjects.com/huamei_9rin5s/afts/img/6KdpRbD5RBEAAAAAWSAAAAgADiB8AQFr/original)

</div>

## Quick Start

Ready to try Neovate Code? Getting started is simple:

```bash
npm install -g @neovate/code
neovate
# Or use the shorter alias
neo
```

We respect the API KEY environment variable for all providers. If you don't have an API Key, enter `/login`, select a provider, open the website, and enter the API Key.

Then enter `/model` to select a model of that provider.

Then you can start to use Neovate Code, describe what you want to do in the command line, review proposed changes and approve tools calls.

```bash
# Examples of what you can do:
"Add error handling to the user authentication function"
"Refactor this component to use TypeScript"
"Create unit tests for the payment service"
"Optimize this database query"
```

Visit our [quickstart](https://neovateai.dev/en/docs/quickstart) documentation for detailed installation and setup instructions.

## 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.

[![](https://www.openomy.com/svg?repo=neovateai/neovate-code&chart=bubble&latestMonth=3)](https://www.openomy.com/github/neovateai/neovate-code)

## License

[MIT](./LICENSE)