README
¶
Welcome to codefly.ai core library
Fundamentals for the
codefly.aiecosystem.
Getting started
Update proto definitions and generate code
./scripts/build/generate.sh
Tests
Wither runner tests
Flaky for now.
go test -tags runner -v ./...
### Publish
TODO: When needed, move to PR system for versioning
*Requirement:* `semver`
```shell
./scripts/publish/tag.sh
or
./scripts/publish/re_tag.sh
Environment Variables
Tips for a Cool README:
-
Engaging Visuals: Include badges for build status, code quality, etc., and consider adding a project logo or screenshots/gifs of your project in action.
-
Clear and Concise: Make your README easy to read with clear headings and concise descriptions.
-
Examples: Include usage examples, as they are extremely helpful to new users.
-
Contribution Guidelines: Encourage community involvement with clear contribution guidelines.
-
License Information: Always specify the license to inform users about how they can use your project.
-
Acknowledgments: Give credit where it's due if you're building upon others' work.
-
Keep it Updated: Regularly update the README as your project evolves.
Remember, the README is often the first thing users or potential contributors see, so making it informative, welcoming, and visually appealing can greatly impact the success of your project.
Directories
¶
| Path | Synopsis |
|---|---|
|
services/audit
Package audit runs language-specific dependency audits on behalf of codefly Builder agents.
|
Package audit runs language-specific dependency audits on behalf of codefly Builder agents. |
|
services/upgrade
Package upgrade applies dependency bumps on behalf of codefly Builder agents.
|
Package upgrade applies dependency bumps on behalf of codefly Builder agents. |
|
testing
Package testing provides helpers for agent composition + lifecycle tests.
|
Package testing provides helpers for agent composition + lifecycle tests. |
|
Package code provides shared implementations for Code service RPCs.
|
Package code provides shared implementations for Code service RPCs. |
|
companions
|
|
|
treesitter
Package treesitter implements code analysis using tree-sitter parsers.
|
Package treesitter implements code analysis using tree-sitter parsers. |
|
treesitter/golang
Package golang registers the Go tree-sitter grammar with the treesitter registry.
|
Package golang registers the Go tree-sitter grammar with the treesitter registry. |
|
treesitter/python
Package python registers the Python tree-sitter grammar with the treesitter registry.
|
Package python registers the Python tree-sitter grammar with the treesitter registry. |
|
generated
|
|
|
go/codefly/cli/v0
Package v0 is a reverse proxy.
|
Package v0 is a reverse proxy. |
|
go/mind/debug/v1
Package debugv1 is a reverse proxy.
|
Package debugv1 is a reverse proxy. |
|
go/mind/v1
Package mindv1 is a reverse proxy.
|
Package mindv1 is a reverse proxy. |
|
runners
|
|
|
testmatrix
Package testmatrix provides a multi-environment test harness.
|
Package testmatrix provides a multi-environment test harness. |
|
Package sdk provides helpers for codefly-managed services.
|
Package sdk provides helpers for codefly-managed services. |
|
leakcheck
Package leakcheck provides test-time helpers for detecting resource leaks: file descriptors, docker containers, and (via go.uber.org/goleak wired at the TestMain level) goroutines.
|
Package leakcheck provides test-time helpers for detecting resource leaks: file descriptors, docker containers, and (via go.uber.org/goleak wired at the TestMain level) goroutines. |
|
otel
Package otel provides an OpenTelemetry backend for wool.
|
Package otel provides an OpenTelemetry backend for wool. |