webxos commited on
Commit
c59eeb0
Β·
verified Β·
1 Parent(s): 1751817

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -39
README.md CHANGED
@@ -13,8 +13,9 @@ tags:
13
  - bio-md
14
  - sandboxed-agent
15
  ---
 
16
  <div align="center">
17
- <pre style="color: #CD7F32; font-size: 10pt; font-weight: bold; line-height: 1.2; margin: 0;">
18
 
19
  β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ•—β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ•—
20
  β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•”β•β•β•β•β•β•šβ•β•β–ˆβ–ˆβ•”β•β•β•β•šβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•”β•β–ˆβ–ˆβ•”β•β•β•β•β•β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘
@@ -26,7 +27,7 @@ tags:
26
  </pre>
27
  </div>
28
 
29
- # 🦞 RustyClaw – Local Agent Harness
30
 
31
  [![Rust Version](https://img.shields.io/badge/rust-1.70%2B-orange)](https://www.rust-lang.org/)
32
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -61,12 +62,8 @@ rustyclaw/
61
  β”œβ”€β”€ Cargo.toml # dependencies
62
  β”œβ”€β”€ start.sh # launcher script (build + run)
63
  β”œβ”€β”€ config.yaml # optional – auto‑created on first run
64
- β”œβ”€β”€ data/ # sandboxed file storage (Git repo)
65
- β”‚ └── logs/
66
- β”‚ └── app.log # JSON log (tracing)
67
- └── ~/.rustyclaw/ # user data directory
68
- β”œβ”€β”€ bio.md # living agent identity (persistent memory)
69
- └── data/ # symlink or actual copy of sandbox
70
  ```
71
 
72
  > **Note:** `~/.rustyclaw/` is created automatically on first launch.
@@ -76,10 +73,11 @@ rustyclaw/
76
 
77
  ## πŸ› οΈ Installation
78
 
79
- ### 1. Install Rust (if not already)
80
  ```bash
81
- curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
82
- source ~/.cargo/env
 
83
  ```
84
 
85
  ### 2. Install Ollama
@@ -95,15 +93,7 @@ sudo apt install git # Debian/Ubuntu
95
  # or brew install git on macOS
96
  ```
97
 
98
- ### 4. Clone and build
99
- ```bash
100
- git clone https://github.com/yourusername/rustyclaw.git
101
- cd rustyclaw
102
- chmod +x start.sh
103
- ./start.sh
104
- ```
105
-
106
- The first build may take a few minutes. Subsequent runs will reuse the cached binary.
107
 
108
  ---
109
 
@@ -243,24 +233,6 @@ All file operations are **sandboxed** – the `sanitize_path` function ensures n
243
 
244
  ---
245
 
246
- ## Development
247
-
248
- To hack on RustyClaw:
249
-
250
- The project is a single Rust file (`src/main.rs`). No modules – easy to experiment.
251
-
252
- ### Adding a new command
253
- 1. Add a variant to `enum AppCommand`.
254
- 2. Add a branch in `handle_command` (inside `AppState`).
255
- 3. Add a matching branch in `run_command` (the dispatcher).
256
- 4. Send the command to the worker via `cmd_tx`.
257
-
258
- ### Changing the UI
259
- The `ui()` function controls layout. The logo is drawn at the top as a `Paragraph`.
260
- You can adjust colours, add more status lines, or change key bindings.
261
-
262
- ---
263
-
264
  ## πŸ“œ License
265
 
266
- MIT License
 
13
  - bio-md
14
  - sandboxed-agent
15
  ---
16
+
17
  <div align="center">
18
+ <pre style="color: #CD7F32; font-size: 3em; font-weight: bold; line-height: 1.2; margin: 0;">
19
 
20
  β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ•—β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ•—
21
  β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•”β•β•β•β•β•β•šβ•β•β–ˆβ–ˆβ•”β•β•β•β•šβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•”β•β–ˆβ–ˆβ•”β•β•β•β•β•β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘
 
27
  </pre>
28
  </div>
29
 
30
+ # 🦞 RustyClaw 0.6.0 – Local Agent Harness
31
 
32
  [![Rust Version](https://img.shields.io/badge/rust-1.70%2B-orange)](https://www.rust-lang.org/)
33
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
62
  β”œβ”€β”€ Cargo.toml # dependencies
63
  β”œβ”€β”€ start.sh # launcher script (build + run)
64
  β”œβ”€β”€ config.yaml # optional – auto‑created on first run
65
+ β”œβ”€β”€ data/ # sandboxed file storage (Git repo) - auto-created on first run
66
+
 
 
 
 
67
  ```
68
 
69
  > **Note:** `~/.rustyclaw/` is created automatically on first launch.
 
73
 
74
  ## πŸ› οΈ Installation
75
 
76
+ ### 1. Once you have the files downloaded run this bash command:
77
  ```bash
78
+ cd ~/rustyclaw (The folder you have the files installed)
79
+ cargo build --release
80
+ ./start.sh --rebuild
81
  ```
82
 
83
  ### 2. Install Ollama
 
93
  # or brew install git on macOS
94
  ```
95
 
96
+ Warning: The first build may take a few minutes. Subsequent runs will reuse the cached binary.
 
 
 
 
 
 
 
 
97
 
98
  ---
99
 
 
233
 
234
  ---
235
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
236
  ## πŸ“œ License
237
 
238
+ MIT License