Skip to content

Commit

Permalink
Added running of the agent section
Browse files Browse the repository at this point in the history
  • Loading branch information
Swiftyos committed Sep 18, 2023
1 parent 060ba07 commit c1abe0e
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`

![Start the Agent](docs/content/imgs/quickstart/009_start_agent.png)

The frontend can be accessed from `http://localhost:8000/`, you will first need to login using either a google account or your github account.

![Login](docs/content/imgs/quickstart/010_login.png)

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.

![Login](docs/content/imgs/quickstart/011_home.png)

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
Binary file added docs/content/imgs/quickstart/009_start_agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/imgs/quickstart/010_login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/imgs/quickstart/011_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c1abe0e

Please sign in to comment.