Skip to content

Commit a8bb264

Browse files
docs: Add issue 40 for console output consistency
Standardize all command output styles around `config show` format.
1 parent c485cea commit a8bb264

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Issue 40: Standardize Console Output Styles
2+
3+
**Status:** TODO
4+
**Priority:** Low
5+
**Target Version:** v1.2.0
6+
**Files:** Multiple files in `remotepy/`
7+
8+
## Problem
9+
10+
Console output styles are inconsistent across commands. For example, `remote config show` and `remote config validate` use different formatting approaches.
11+
12+
## Solution
13+
14+
Audit all console output across the codebase and standardize around the style used by `remote config show`.
15+
16+
## Scope
17+
18+
Review and align output for:
19+
- `config show` (reference style)
20+
- `config validate`
21+
- `instance status` / `instance list`
22+
- `instance start` / `instance stop`
23+
- `ami list` / `ami create`
24+
- `ecs status` / `ecs scale`
25+
- `volume list`
26+
- `snapshot list` / `snapshot create`
27+
- `template list` / `template show`
28+
- Error messages and success confirmations
29+
30+
## Acceptance Criteria
31+
32+
- [ ] Document the target output style based on `config show`
33+
- [ ] Audit all commands for style inconsistencies
34+
- [ ] Update inconsistent outputs to match target style
35+
- [ ] Add tests to verify output formatting
36+
- [ ] Update any relevant documentation

specs/plan.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,4 @@ Features and improvements for future releases.
7474
| 20 | 37 | Pricing API region fallback | Pricing API only works in us-east-1; fallback to us-east-1 pricing for other regions | [issue-37](./issue-37-pricing-region-fallback.md) | COMPLETED |
7575
| 21 | 38 | Instance cost command | Add command to show estimated cost of instance based on uptime | [issue-38](./issue-38-instance-cost-command.md) | TODO |
7676
| 22 | 39 | Scheduled instance shutdown | Schedule instance to stop after specified duration (e.g., "3 hours") | [issue-39](./issue-39-scheduled-shutdown.md) | COMPLETED |
77+
| 23 | 40 | Standardize console output styles | Align all command output to match `config show` style for consistency | [issue-40](./issue-40-console-output-consistency.md) | TODO |

0 commit comments

Comments
 (0)