diff options
| author |  SwiftyOS <craigswift13@gmail.com>
| 2023-09-18 16:37:54 +0200 |
|---|---|---|
| committer | SwiftyOS <craigswift13@gmail.com>
| 2023-09-18 16:37:54 +0200 |
| commit | c1abe0e85f8676501497df0b718b91af47b88fed (patch) | |
| tree | a6124d3d4124e2091a796ff9c7394bbdeb996109 /QUICKSTART.md | |
| parent | Added another origin for requests to the agent server (diff) | |
| download | Auto-GPT-c1abe0e85f8676501497df0b718b91af47b88fed.tar.gz Auto-GPT-c1abe0e85f8676501497df0b718b91af47b88fed.tar.bz2 Auto-GPT-c1abe0e85f8676501497df0b718b91af47b88fed.zip | |
Added running of the agent section
Diffstat (limited to 'QUICKSTART.md')
| -rw-r--r-- | QUICKSTART.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/QUICKSTART.md b/QUICKSTART.md index 9699c0a12..dae03edab 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -66,3 +66,28 @@ - timestamp: timestamp of the last update of this file - commit_hash_to_benchmark: the commit hash of your entry. You update each time you have an something ready to be offically entered into the hackathon - branch_to_benchmark: the branch you are using to develop your agent on, default is master. + + +## Running your Agent + +Your agent can started using the `./run agent start YOUR_AGENT_NAME` + +This will build the frontend, install the dependencies and then start the agent on `http://localhost:8000/` + + + +The frontend can be accessed from `http://localhost:8000/`, you will first need to login using either a google account or your github account. + + + +Upon logging in you will get a page that looks something like this. With your task history down the left hand side of the page and the 'chat' window to send tasks to your agent. + + + +When you have finished with your agent, or if you just need to restart it, use Ctl-C to end the session then you can re-run the start command. + +If you are having issues and want to ensure the agent has been stopped there is a `./run agent stop` command which will kill the process using port 8000, which should be the agent. + +## Benchmarking your Agent + +> Todo
\ No newline at end of file |