Skip to content

Commit 7c44fad

Browse files
committed
docs: Update readme (added run from NPM registry)
1 parent 8d05005 commit 7c44fad

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ A lightweight autonomous AI coding agent with terminal-based UI, inspired by Cod
1111
- **Web Integration**: Built-in web search and URL fetching capabilities
1212
- **Memory System**: Persistent knowledge graph for maintaining context across sessions
1313
- **Multiple LLM Providers**: Support for OpenRouter, LMStudio, and OpenAI
14+
- **MCP Servers**: Support for multiple MCP servers
1415
- **Docker Support**: Easy containerization for portable development environments
1516

1617
## Configuration
@@ -27,7 +28,18 @@ user_instructions: | # Custom personality/role instructions
2728
Your goal is to build working software based on user request.
2829
```
2930
30-
## Official Docker Image
31+
## Running
32+
There are several ways to run Huly Coder:
33+
34+
### From NPM Registry
35+
36+
Create a `huly-coder-local.yaml` file with overrided configurations and run the following command:
37+
38+
```bash
39+
npx huly-coder -d <data_dir> -s <huly-coder-local.yaml>
40+
```
41+
42+
### Official Docker Image
3143

3244
To run Huly Coder in docker, create a `huly-coder-local.yaml` file in your `data` directory with overrided configurations and run the following command:
3345

@@ -37,14 +49,16 @@ docker run -e DOCKER_RUN=1 \
3749
-v "<data_dir>:/data" \
3850
-v "<data_dir>/.fastembed_cache:/.fastembed_cache" \
3951
-it --rm hardcoreeng/huly-coder:latest
52+
--config /data/huly-coder-local.yaml
53+
--data /data
4054
```
4155

42-
## Local Run
56+
### Local Run
4357

4458
To run Huly Coder locally, run:
4559

4660
```bash
47-
cargo run
61+
cargo run -d <data_dir> -s <huly-coder-local.yaml>
4862
```
4963

5064
## Docker

0 commit comments

Comments
 (0)