[cvas22]

Fixes #569

Adds an optional --output-file flag to fga tuple read, following the proposal in the issue.

• Without the flag nothing changes: output goes to stdout.
• With the flag, the output is written only to that file, in the selected --output-format (json, simple-json, yaml or csv).
• The file is created with 0600 permissions, and only after the output has been produced, so a conversion error does not leave a partial file. An error is returned if the file cannot be written.

This adds output.Render (JSON/YAML without colors, returning bytes) and splits the display code in cmd/tuple/read.go into displayReadResponse and writeReadResponseToFile. The README documents the new flag.

Tests: file output for json, simple-json, yaml and csv (content and permissions), that the simple-json file parses back into tuple keys, the write error case, and Render. I ran go test ./cmd/tuple -run "DisplayReadResponse|TestRead" and go test ./internal/output. A different test in cmd/tuple (TestParseTuplesFileData) fails on Windows because it compares an OS error message; it is unrelated to this change.

Summary by CodeRabbit

• New Features
  • Added an --output-file option to tuple read to save results in the selected format instead of printing them to standard output. Output files are created with restricted permissions.
• Documentation
  • Updated the command documentation to describe the new option.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: b82ba097-ae9b-4753-b832-782876d64db6

📥 Commits

Reviewing files that changed from the base of the PR and between ed9e19d and 1042d02.

📒 Files selected for processing: 5

• README.md
• cmd/tuple/read.go
• cmd/tuple/read_test.go
• internal/output/marshal.go
• internal/output/marshal_test.go

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

fga tuple read now accepts --output-file and writes results in the selected format to that file. Without the flag, results continue to go to stdout. File writes use 0600 permissions.

Changes

Tuple read output

Layer / File(s)	Summary
Format rendering internal/output/marshal.go, internal/output/marshal_test.go	Render returns YAML or indented JSON bytes. Tests check the expected output for both formats.
Tuple read file output cmd/tuple/read.go, cmd/tuple/read_test.go, README.md	The command routes output to stdout or a file. File output handles CSV conversion or renders other formats, writes with 0600 permissions, and returns errors. Tests cover content, permissions, tuple keys, and write failures. The README documents the flag.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant TupleRead
  participant DisplayReadResponse
  participant FileWriter
  participant OutputRender
  participant OutputFile
  TupleRead->>DisplayReadResponse: pass response, format, and output path
  DisplayReadResponse->>FileWriter: write response to the selected path
  FileWriter->>OutputRender: render non-CSV output
  OutputRender-->>FileWriter: return formatted bytes
  FileWriter->>OutputFile: write bytes with 0600 permissions

Loading

Suggested reviewers: soulpancake

Merge Risk: ⚪ Minimal · up to 1042d

This change adds an optional --output-file flag to tuple read and leaves stdout behavior unchanged when the flag is absent. No concrete merge-blocking risk remains.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 27.27% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 11 functions across 4 files. (1 skipped: …	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: adding the --output-file option to tuple read.
Linked Issues check		Issue #569 asks for an --output-file option on fga tuple read that writes tuples to a file instead of stdout. At head, cmd/tuple/read.go registers the flag (readCmd.Flags().String("output-file", "", .…
Out of Scope Changes check		All changed areas support the --output-file feature. cmd/tuple/read.go adds the flag and the file-write path, and extracts displayReadResponse for the shared stdout and file logic. internal/output/mar…

Full details: Linked Issues check

Explanation

Issue #569 asks for an --output-file option on fga tuple read that writes tuples to a file instead of stdout. At head, cmd/tuple/read.go registers the flag (readCmd.Flags().String("output-file", "", ...)). The read command passes outputFile to displayReadResponse. When outputFile is non-empty, displayReadResponse calls writeReadResponseToFile. That function builds the content in the selected format (CSV via MarshalCSV, other formats via output.Render) and writes it with os.WriteFile(..., 0o600) only after rendering succeeds. When the flag is empty, the stdout path keeps the previous CSV and UniPrinter behavior. internal/output/marshal.go (read at head) defines Render, which returns JSON or YAML bytes without colors and ends with a newline. The issue sets no further acceptance criteria. The PR summary reports tests for file output in all four formats, permissions, and write errors. I did not read the test files directly. The marshal.go diff was unavailable, so I relied on the file read at head for Render. The conclusion rests on the read.go diff and the head file content.

Full details: Out of Scope Changes check

Explanation

All changed areas support the --output-file feature. cmd/tuple/read.go adds the flag and the file-write path, and extracts displayReadResponse for the shared stdout and file logic. internal/output/marshal.go adds Render, which the file path uses for JSON and YAML output. README.md documents the new flag. The test files cover the new file-output behavior and Render. The stdout path keeps its previous behavior. The diff shows no unrelated refactoring or behavior change. The PR description notes an unrelated Windows failure in TestParseTuplesFileData. That test does not appear in the summarized changes, so it does not count as an out-of-scope change here.

Full details: Docstring Coverage

Explanation

Docstring coverage is 27.27% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 11 functions across 4 files. (1 skipped: 1 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}