docs: update README to match v0.0.7 state of codebase #13
Conversation
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
…tation
- Add version number v0.0.7 to header
- Fix sos session command syntax (--image instead of -i)
- Add missing CLI flags:
- --timeout SECONDS for sos serve
- --formatted for sos sandbox trajectory
- --remove for sos sandbox stop
- Document complete HTTP API:
- Add GET /sandboxes/{id}/trajectory/formatted endpoint
- Document SandboxInfo response fields
- Document CommandResult fields including exited
- Document request parameters (timeout, remove)
- Fix typo in sos sandbox --server example
- Update setup command syntax to show multiple --setup flags
- Document --timeout parameter for server (default 600s)
- Add more complete usage examples including Python and Node.js workflows
Owner
|
@docbrown-dev can you also bump to 0.0.8 |
Author
|
On it — I'll bump the version to 0.0.8. |
Author
|
Done! I've bumped the version to 0.0.8 in Cargo.toml and pushed the change. Change made:
The change is now on the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Updated the README.md documentation to accurately reflect the current state of the codebase (v0.0.7).
Changes
Fixed Issues
sos session -itosos session --image(the-iflag doesn't exist)sos sandbox --serverexampleAdded Documentation
--timeout SECONDSforsos serve(default: 600s)--formatted/-fforsos sandbox trajectory--remove/-rforsos sandbox stopComplete HTTP API Reference
GET /sandboxes/{id}/trajectory/formattedendpointSandboxInforesponse fields:id,status,image,setup_commands,session_command_count,last_standalone_exit_codecreated_at,started_at,stopped_at,container_idCommandResultfields including theexitedbooleantimeout,remove,standalone,image,setup_commands)Enhanced Usage Examples
&&--setupflags are supportedVerification
All changes were verified against the actual source code:
src/cli/main.rs- CLI command definitions and flagssrc/lib/http.rs- HTTP API endpoints and response structuressrc/lib/sandbox/mod.rs- Sandbox implementation and public APIThe documentation now accurately reflects the current CLI interface and HTTP API.