oldwinter / oldwinter/all-cli

体验:all-cli snapshot 说给 diff 用,默认却打人表

Open Beginner friendly
#70 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1
Forks
0
Avg merge
7d 23h
Merged PRs (30d)
24

Description

体验:all-cli snapshot 说给 diff 用,默认却打人表,没有 --json 示例

不重复 #67(diff 缺参)。

用户路径
  1. Short:Capture a status snapshot for later diffing
  2. all-cli snapshot 默认 PrintStatusTableall-cli diff 读的是 JSON snapshot 文件。
  3. 原先没有 Long/Example。用户把表格存成文件再 diff,会失败。
  4. 正确路径是 all-cli snapshot --json > before.json
建议改动

Long 写明 --json 才能给 diff 用;Example 给出 before/after + all-cli diff

本地 clone 已按此改了一版(未 push / 未开 PR)。

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the all-cli snapshot command entry point and inspect its current Long text and Example output, then compare how all-cli diff consumes snapshot files. Update the help text to explain that --json is required and show the before/after snapshot flow, including all-cli diff. Verify the rendered help and that the documented commands produce JSON files usable by diff.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.