# AGENTS.md

A tool for secrets management, encryption as a service, and privileged access management

## Setup

```
go mod download
```

## Commands

```
make default
make bin
make dev       # run locally
make dev       # run locally
make dev-ui
make dev-ui
```

## Layout

- `ui/`      2361 source files
- `vault/`   480 source files
- `builtin/` 404 source files
- `command/` 365 source files
- `sdk/`     354 source files
- `tools/`   195 source files

## Conventions

- Tests live alongside the code they cover, following `api/api_test.go`.
- CI defines what passing means. See `.github/workflows/actionlint.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `builtin/logical/pki/backend_test.go` is 291KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.