mirror of
https://github.com/fatedier/frp.git
synced 2026-03-20 16:59:18 +08:00
d20e384bf1
* web: remove redundant SCSS and CSS files superseded by shared * doc: add agent runbooks directory with release process
40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
# AGENTS.md
|
|
|
|
## Development Commands
|
|
|
|
### Build
|
|
- `make build` - Build both frps and frpc binaries
|
|
- `make frps` - Build server binary only
|
|
- `make frpc` - Build client binary only
|
|
- `make all` - Build everything with formatting
|
|
|
|
### Testing
|
|
- `make test` - Run unit tests
|
|
- `make e2e` - Run end-to-end tests
|
|
- `make e2e-trace` - Run e2e tests with trace logging
|
|
- `make alltest` - Run all tests including vet, unit tests, and e2e
|
|
|
|
### Code Quality
|
|
- `make fmt` - Run go fmt
|
|
- `make fmt-more` - Run gofumpt for more strict formatting
|
|
- `make gci` - Run gci import organizer
|
|
- `make vet` - Run go vet
|
|
- `golangci-lint run` - Run comprehensive linting (configured in .golangci.yml)
|
|
|
|
### Assets
|
|
- `make web` - Build web dashboards (frps and frpc)
|
|
|
|
### Cleanup
|
|
- `make clean` - Remove built binaries and temporary files
|
|
|
|
## Testing
|
|
|
|
- E2E tests using Ginkgo/Gomega framework
|
|
- Mock servers in `/test/e2e/mock/`
|
|
- Run: `make e2e` or `make alltest`
|
|
|
|
## Agent Runbooks
|
|
|
|
Operational procedures for agents are in `doc/agents/`:
|
|
- `doc/agents/release.md` - Release process
|