Skip to content

Commit 2ccd22a

Browse files
update readme
1 parent 27fd033 commit 2ccd22a

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ https://github.com/user-attachments/assets/51cf6ad1-196c-44ab-99ba-0035365f1bbd
2525
* Calculates and improves the complexity score using `complexipy` to be under 15
2626
* Auto-formats the code with `autopep8`
2727
* Shows the token count used for the responses
28+
* Run via UV (uvx)
2829

2930
## Coding Ability
3031
* `leetcode` hards
@@ -50,8 +51,8 @@ https://github.com/user-attachments/assets/51cf6ad1-196c-44ab-99ba-0035365f1bbd
5051
* `echo 'export OPENAI_API_KEY="YOUR_API_KEY"' >> ~/.zshrc` or
5152
* `echo 'export ANTHROPIC_API_KEY="YOUR_API_KEY"' >> ~/.zshrc` or
5253
* `echo 'export GEMINI_API_KEY="YOUR_API_KEY"' >> ~/.zshrc`
53-
* `pip install nemo-agent`
54-
* You are ready to use `nemo-agent`
54+
* `pip install uv`
55+
* `uvx nemo-agent` - to run nemo-agent
5556

5657
### OR
5758

@@ -67,40 +68,40 @@ https://github.com/user-attachments/assets/51cf6ad1-196c-44ab-99ba-0035365f1bbd
6768
* Ollama install instructions:
6869
* `curl -fsSL https://ollama.com/install.sh | sh`
6970
* `ollama pull qwen2.5-coder:14b`
70-
* `pip install nemo-agent`
71-
* You are ready to use `nemo-agent`
71+
* `pip install uv`
72+
* `uvx nemo-agent` - to run nemo-agent
7273

7374
## Usage
7475

7576
### Providers
76-
* `ollama`: `nemo-agent --provider ollama`
77-
* `openai`: `nemo-agent --provider openai`
78-
* `claude`: `nemo-agent --provider claude`
79-
* `gemini`: `nemo-agent --provider gemini`
77+
* `ollama`: `uvx nemo-agent --provider ollama`
78+
* `openai`: `uvx nemo-agent --provider openai`
79+
* `claude`: `uvx nemo-agent --provider claude`
80+
* `gemini`: `uvx nemo-agent --provider gemini`
8081

8182
### Import Reference Documentation Into Prompt
8283
* Documentation files must be either: .md (Markdown) or .txt (Text) and be located in a folder
83-
* `nemo-agent --docs example_folder`
84+
* `uvx nemo-agent --docs example_folder`
8485

8586
### Import Existing Code Projects Into Prompt
8687
* Code files must be either: .py (Python), .php (PHP), .rs (Rust), .js (JavaScript), .ts (TypeScript), .toml (TOML), .json (JSON), .rb (Ruby), or .yaml (YAML) and be located in a folder
87-
* `nemo-agent --code example_folder`
88+
* `uvx nemo-agent --code example_folder`
8889

8990
### Import Data Into Prompt
9091
* Data files must be .csv (CSV) and be located in a folder
91-
* `nemo-agent --data example_folder`
92+
* `uvx nemo-agent --data example_folder`
9293

9394
### Prompting
9495

9596
#### CLI
96-
* `nemo-agent "create a fizzbuzz script"`
97+
* `uvx nemo-agent "create a fizzbuzz script"`
9798

9899
#### OR
99100

100101
#### File Prompt
101102
* Prompt file must be markdown (.md) or text files (.txt)
102-
* `nemo-agent --file example.md` or
103-
* `nemo-agent --file example.txt`
103+
* `uvx nemo-agent --file example.md` or
104+
* `uvx nemo-agent --file example.txt`
104105

105106
### Run Generated Program
106107
* `cd generated_project_folder`
@@ -115,7 +116,7 @@ Tests are automatically created and run.
115116

116117
You many want to skip tests especially if you are generating a UI application.
117118

118-
* `nemo-agent "create a fizzbuzz script" --tests False`
119+
* `uvx nemo-agent "create a fizzbuzz script" --tests False`
119120

120121
## Models
121122

@@ -126,7 +127,7 @@ You many want to skip tests especially if you are generating a UI application.
126127
* `gemini` is `gemini-2.0-flash`
127128

128129
### Select Models
129-
* `nemo-agent "my_prompt" --provider openai --model o3-mini`
130+
* `uvx nemo-agent "my_prompt" --provider openai --model o3-mini`
130131

131132
### Supported Models
132133

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "nemo-agent"
3-
version = "3.4.0"
3+
version = "3.4.1"
44
description = "Your Python AI Coder"
55
authors = ["Bevan Hunt <bevan@bevanhunt.com>"]
66
license = "MIT"

0 commit comments

Comments
 (0)