docs: add engineering guide for agentflow-api (API server + CLI)#42
Merged
Conversation
Iamsdt
commented
Jun 13, 2026
Iamsdt
commented
Collaborator
- Introduced CLAUDE.md to document the API server and CLI package.
- Detailed package information including version, requirements, and console entry point.
- Explained the purpose of the package and its layout.
- Listed CLI commands with their purposes and notable options.
- Described the configuration contract via agentflow.json and its supported keys.
- Outlined authentication methods and HTTP/WebSocket endpoints.
- Provided development workflow instructions and noted known documentation discrepancies.
- Introduced CLAUDE.md to document the API server and CLI package. - Detailed package information including version, requirements, and console entry point. - Explained the purpose of the package and its layout. - Listed CLI commands with their purposes and notable options. - Described the configuration contract via agentflow.json and its supported keys. - Outlined authentication methods and HTTP/WebSocket endpoints. - Provided development workflow instructions and noted known documentation discrepancies.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.