@neovate/code 0.12.1 → 0.12.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,45 +1,57 @@
1
- # Neovate
1
+ <div align="center">
2
+ <img src="https://mdn.alipayobjects.com/huamei_9rin5s/afts/img/0uIJQaelzccAAAAAQCAAAAgADiB8AQFr/original" alt="Neovate Code Logo" width="60" />
3
+ <br />
4
+ <br />
5
+ <img src="https://mdn.alipayobjects.com/huamei_9rin5s/afts/img/UdphTJIBImUAAAAAQKAAAAgADiB8AQFr/original" alt="Neovate Code Logo Text" width="160" />
6
+
7
+ ---
2
8
 
3
9
  [![](https://badgen.net/npm/v/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
4
10
  [![](https://badgen.net/npm/dm/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
5
11
  [![](https://github.com/neovateai/neovate-code/actions/workflows/test.yml/badge.svg)](https://github.com/neovateai/neovate-code/actions/workflows/test.yml)
6
12
  [![](https://badgen.net/npm/license/@neovate/code)](https://www.npmjs.com/package/@neovate/code)
7
13
 
8
- Neovate, pronounced as `['niːəʊveɪt]`, is a coding agent to enhance your development workflow.
14
+ **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.
9
15
 
10
- ## Getting Started
16
+ See more at [neovateai.dev](https://neovateai.dev).
11
17
 
12
- > Make sure you have Node.js version 18 or higher installed.
18
+ ![](https://mdn.alipayobjects.com/huamei_9rin5s/afts/img/6KdpRbD5RBEAAAAAWSAAAAgADiB8AQFr/original)
13
19
 
14
- 1. **Install the CLI globally.** Use npm or other package managers.
20
+ </div>
15
21
 
16
- ```bash
17
- $ npm install -g @neovate/code
18
- ```
22
+ ## Quick Start
19
23
 
20
- 2. **Set up the API keys.** Configure one or more API keys for the LLMs providers.
24
+ Ready to try Neovate Code? Getting started is simple:
21
25
 
22
26
  ```bash
23
- $ export OPENAI_API_KEY="sk-..."
24
- $ export GOOGLE_API_KEY="sk-..."
25
- $ export ANTHROPIC_API_KEY="sk-..."
26
- $ export DEEPSEEK_API_KEY="sk-..."
27
- $ export XAI_API_KEY="sk-..."
28
- $ export AIHUBMIX_API_KEY="sk-..."
29
- $ export OPENROUTER_API_KEY="sk-..."
27
+ npm install -g @neovate/code
28
+ neovate
29
+ # Or use the shorter alias
30
+ neo
30
31
  ```
31
32
 
32
- You are now ready to use Neovate.
33
+ 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.
34
+
35
+ Then enter `/model` to select a model of that provider.
36
+
37
+ 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.
33
38
 
34
39
  ```bash
35
- $ neovate
36
- > explain this codebase to me
40
+ # Examples of what you can do:
41
+ "Add error handling to the user authentication function"
42
+ "Refactor this component to use TypeScript"
43
+ "Create unit tests for the payment service"
44
+ "Optimize this database query"
37
45
  ```
38
46
 
47
+ Visit our [quickstart](https://neovateai.dev/en/docs/quickstart) documentation for detailed installation and setup instructions.
48
+
39
49
  ## Contributing
40
50
 
41
51
  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.
42
52
 
53
+ [![](https://www.openomy.com/svg?repo=neovateai/neovate-code&chart=bubble&latestMonth=3)](https://www.openomy.com/github/neovateai/neovate-code)
54
+
43
55
  ## License
44
56
 
45
57
  [MIT](./LICENSE)