docs: correct CLI output behavior in README (fixes #220) - #242
Open
Munawarx wants to merge 1 commit into
Open
Conversation
The CLI prints structured JSON to stdout, not the filesystem. Verified with 'tinyfish fetch content get https://example.com' — output is JSON on stdout, no file written. Updated README to reflect actual behavior and how users can redirect to a file for low-token local storage. Fixes tinyfish-io#220
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Problem
The README (CLI section) claims:
The CLI writes results to the filesystem instead of piping them through your model's context window.Actual behavior of
@tiny-fish/cli(v0.6.1) does not match this. The CLI prints structured JSON to stdout.Evidence
Ran a real command:
Output was JSON on stdout; no file was written to the filesystem (verified by diffing the directory before/after). The npm package description also only states
run web automations from your terminalwith no filesystem-write claim.Root cause
Stale/aspirational documentation that no longer reflects the current CLI.
Solution
Replaced the misleading sentence with an accurate description of stdout output, and showed how users can redirect to a file themselves (
tinyfish fetch ... > out.json) if they want low-token local persistence.Testing
tinyfish fetchstdout behavior.Expected impact
Removes misleading info so users don't expect filesystem writes that don't happen; improves docs accuracy.
Fixes #220