-
Notifications
You must be signed in to change notification settings - Fork 1
Update READMEs to match actual CLI surface area + bump versions to 1.0 #93
Copy link
Copy link
Closed
Labels
enhancementNew feature or requestNew feature or request
Description
Context
Both tool READMEs are stale — they were written for the standalone repos and haven't been updated to reflect commands added since consolidation. The root README has incorrect cfl command syntax. Version references (Go requirement, release URLs) also need updating.
Part 1: README Gap Analysis
jtk README — Missing commands
| Command | Status |
|---|---|
jtk issues delete |
Not documented |
jtk issues field-options |
Not documented |
jtk issues types |
Not documented |
jtk issues move |
Not documented |
jtk issues move-status |
Not documented |
jtk attachments list/add/get/delete |
Entire section missing |
jtk automation list/get/export/create/update/enable/disable |
Entire section missing |
jtk users search |
Not documented |
jtk sprints add |
Not documented |
jtk comments delete |
Not documented |
--full flag on issues get |
Not documented |
--full flag on comments list |
Not documented |
--fields flag on transitions list |
Not documented |
--field flag on transitions do |
Not documented |
--state flag on sprints list |
Not documented |
--no-color global flag |
Not documented |
--verbose global flag |
Not documented |
--unassign flag on issues assign |
Not documented |
--custom flag on issues fields |
Not documented |
jtk README — Incorrect content
| Issue | Details |
|---|---|
jtk config set documented but doesn't exist |
Actual setup is jtk init |
| Go 1.22 prerequisite | Actually Go 1.24 |
| Release URLs point to old repo | jira-ticket-cli/releases → atlassian-cli/releases |
--config global flag listed but doesn't exist |
jtk root command has no --config flag |
--version listed as -v |
Conflicts with --verbose which is actually -v |
issues list shows --limit |
Code uses --max / -m |
issues create shows --type as required |
Default is "Task" |
issues search shows --limit |
Code uses --max / -m |
issues create missing --field flag |
Supports -f/--field for custom fields |
cfl README — Missing commands
| Command | Status |
|---|---|
cfl config show |
Not documented |
cfl config test |
Not documented |
cfl config clear |
Not documented |
cfl README — Incorrect content
| Issue | Details |
|---|---|
page view missing --full flag |
Added recently, not in docs |
| Go 1.22 prerequisite | Actually Go 1.24 |
| Release URLs point to old repo | confluence-cli/releases → atlassian-cli/releases |
Root README — Issues
| Issue | Details |
|---|---|
cfl page search |
Should be cfl search (not under page) |
cfl attachment list 123456 |
Missing --page flag: cfl attachment list --page 123456 |
cfl attachment upload 123456 --file |
Missing --page flag |
cfl attachment download 123456 image.png --output |
Wrong syntax — takes attachment-id, not page-id |
| Go 1.21 prerequisite | Actually Go 1.24 |
Part 2: Version Bump
Bump both to 1.0:
tools/cfl/version.txt:0.9→1.0tools/jtk/version.txt:0.1→1.0
Next releases will be cfl-v1.0.X and jtk-v1.0.X.
Note: The version bump files are not .go files, so they won't trigger auto-release on their own. The README changes are also docs-only. To trigger a release with the new versions, we'd need a subsequent feat: or fix: commit that touches Go files — or manually push tags.
Files to modify
tools/jtk/README.md— Major rewrite: add missing command docs, fix incorrect docs, update URLs and Go versiontools/cfl/README.md— Add config commands section, add--fullflag, update URLs and Go versionREADME.md(root) — Fix cfl command examples, update Go versiontools/cfl/version.txt—0.9→1.0tools/jtk/version.txt—0.1→1.0
Approach
- Add new command sections matching the style/format of existing ones (flag tables, examples, arguments)
- Fix all incorrect flag names and defaults
- Update all release URLs from old repos to
atlassian-cli/releases - Update Go prerequisite from 1.21/1.22 to 1.24
- Remove the nonexistent
jtk config setsection, replace withjtk initdocs
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request