Skip to content

Add a basic README install section #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asim merged 1 commit into from
Nov 1, 2026
Merged

Add a basic README install section #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,36 @@ By default, Support covers this repository and Go Micro. DevOps and Monitor
inspect the units in [deploy](deploy). Follow that guide to run the agents together
on one host, or override their targets for your own environment.

## Development
## Install

Requires Go 1.26 or newer, with Go's bin directory on your PATH.

```sh
go install go-micro.dev/v6/cmd/micro@master
git clone https://github.com/micro/agents
cd agents
```

Set your model credentials and configure [Release's workflow](release#run)
before starting the full set. For example, with OpenAI:

Requires Go 1.26 or newer.
```sh
export MICRO_AI_PROVIDER=openai
export MICRO_AI_API_KEY=your-model-key
micro run
```

In another terminal, with the same model settings:

```sh
micro chat
```

`micro run` builds and starts the agents as separate local processes; Ctrl+C
stops them. DevOps and Monitor currently inspect systemd units, which
`micro run` does not create. For a Linux server installation, see [deploy](deploy).

## Development

```sh
go test -race ./...
Expand Down
Loading