oxidecomputer / oxidecomputer/oxide.rs
Add option to display API calls made by CLI
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
Target component
- CLI
- SDK
- Something else
- Not sure
Overview
Optionally output the raw HTTPS for the API call triggered by the command being run, e.g. by supplying an extra flag.
This would allow for easier debugging of issues triggered via CLI (no need to consult server logs) and can be used to streamline users' development of API tooling (use this flag on a CLI command to do XYZ, get a working example of an HTTPS request).
The vision here is something similar to the -v or --trace options of curl, which could display URL, filepath, headers, content, etc. in a functional/readable format. Maybe it could be two different options for dumping human-readable headers vs json that could be immediately edited/re-used.
Implementation details
No response
Anything else you would like to add?
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by locating the CLI command handling and the code that constructs API requests, then inspect existing flag and output conventions. Done means a CLI option displays the triggered request in a readable or reusable format without changing normal output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100