@@ -62,59 +62,59 @@ sudo apt install libxcb1-dev # libxcb1-dev is the development package for t
6262
6363### Rust
6464
65- First let's compile goose and try it out
65+ First, activate the hermit environment and compile goose:
6666
6767```
68+ source bin/activate-hermit
6869cargo build
6970```
7071
71- when that is done, you should now have debug builds of the binaries like the goose cli :
72+ When that completes, debug builds of the binaries are available, including the goose CLI :
7273
7374```
7475./target/debug/goose --help
7576```
7677
77- If you haven't used the CLI before, you can use this compiled version to do first time configuration :
78+ For first-time setup, run the configure command :
7879
7980```
8081./target/debug/goose configure
8182```
8283
83- And then once you have a connection to an LLM provider working, you can run a session!
84+ Once a connection to an LLM provider is working, start a session:
8485
8586```
8687./target/debug/goose session
8788```
8889
8990These same commands can be recompiled and immediately run using ` cargo run -p goose-cli ` for iteration.
90- As you make changes to the rust code, you can try it out on the CLI, or also run checks, tests, and linter:
91+ When making changes to the Rust code, test them on the CLI or run checks, tests, and the linter:
9192
9293```
93- cargo check # do your changes compile
94- cargo test # do the tests pass with your changes
95- cargo fmt # format your code
94+ cargo check # verify changes compile
95+ cargo test # run tests with changes
96+ cargo fmt # format code
9697./scripts/clippy-lint.sh # run the linter
9798```
9899
99100### Node
100101
101- Now let's make sure you can run the app.
102+ To run the app:
102103
103104```
104105just run-ui
105106```
106107
107- The start gui will both build a release build of rust (as if you had done ` cargo build -r ` ) and start the electron process.
108- You should see the app open a window, and drop you into first time setup. When you've gone through the setup,
109- you can talk to goose!
108+ This command builds a release build of Rust (equivalent to ` cargo build -r ` ) and starts the Electron process.
109+ The app opens a window and displays first-time setup. After completing setup, goose is ready for use.
110110
111- You can now make changes in the code in ui/desktop to iterate on the GUI half of goose .
111+ Make GUI changes in ` ui/desktop ` .
112112
113113### Regenerating the OpenAPI schema
114114
115115The file ` ui/desktop/openapi.json ` is automatically generated during the build.
116116It is written by the ` generate_schema ` binary in ` crates/goose-server ` .
117- If you need to update the spec without starting the UI, run:
117+ To update the spec without starting the UI, run:
118118
119119```
120120just generate-openapi
@@ -123,29 +123,28 @@ just generate-openapi
123123This command regenerates ` ui/desktop/openapi.json ` and then runs the UI's
124124` generate-api ` script to rebuild the TypeScript client from that spec.
125125
126- Changes to the API should be made in the Rust source under ` crates/goose-server/src/ ` .
126+ API changes should be made in the Rust source under ` crates/goose-server/src/ ` .
127127
128128### Debugging
129129
130- To debug the Goose server, you can run it from your preferred IDE. How to configure the command
131- to start the server will depend on your IDE. The command to run is:
130+ To debug the Goose server, run it from an IDE. The configuration will depend on the IDE. The command to run is:
132131
133132```
134133export GOOSE_SERVER__SECRET_KEY=test
135134cargo run --package goose-server --bin goosed -- agent # or: `just run-server`
136135```
137136
138- The server will start listening on port ` 3000 ` by default, but this can be changed by setting the
137+ The server listens on port ` 3000 ` by default; this can be changed by setting the
139138` GOOSE_PORT ` environment variable.
140139
141- Once the server is running, you can start a UI and connect it to the server by running:
140+ Once the server is running, start a UI and connect it to the server by running:
142141
143142```
144143just debug-ui
145144```
146145
147- The UI will now be connected to the server you started in your IDE, allowing you to set breakpoints
148- and step through the server code as you interact with the UI.
146+ The UI connects to the server started in the IDE, allowing breakpoints
147+ and stepping through the server code while interacting with the UI.
149148
150149## Creating a fork
151150
0 commit comments