Skip to content

Commit 52d1ca0

Browse files
committed
✨ CLI 가이드 및 README에 목록 명령어 추가; 사용법, 서브커맨드, 옵션 및 출력 형식에 대한 상세 설명 포함
1 parent 1aa812a commit 52d1ca0

5 files changed

Lines changed: 7828 additions & 10 deletions

File tree

.kiro/specs/taptik-list-command/tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
- Test CLI output formatting and error handling
6464
- _Requirements: All requirements (end-to-end validation)_
6565

66-
- [ ] 10. Update CLI registration and help documentation
66+
- [x] 10. Update CLI registration and help documentation
6767
- Register ListCommand in the main CLI application
6868
- Update help text and command documentation
6969
- Ensure proper command discovery and execution

CLI_GUIDE.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,78 @@ npm run cli -- --help
3737
| `build:test` | Test build functionality | `npm run build:test` |
3838
| `test:cli` | Run CLI integration tests | `npm run test:cli` |
3939

40+
## 📋 List Command Deep Dive
41+
42+
### Overview
43+
44+
The list command provides discovery and exploration of configuration packages stored in the Taptik cloud. It allows users to browse, filter, and sort available configurations through an intuitive command-line interface.
45+
46+
### Basic Usage
47+
48+
```bash
49+
# List all public configurations
50+
npm run cli -- list
51+
52+
# Filter configurations by title
53+
npm run cli -- list --filter "frontend"
54+
npm run cli -- list --filter "typescript"
55+
56+
# Sort configurations
57+
npm run cli -- list --sort date # Sort by creation date (default)
58+
npm run cli -- list --sort name # Sort alphabetically by title
59+
60+
# Limit results
61+
npm run cli -- list --limit 10 # Show 10 results
62+
npm run cli -- list --limit 50 # Show 50 results (max: 100)
63+
64+
# Combine options
65+
npm run cli -- list --filter "react" --sort name --limit 20
66+
```
67+
68+
### Subcommands
69+
70+
#### Liked Configurations
71+
72+
```bash
73+
# List configurations you've liked (requires authentication)
74+
npm run cli -- list liked
75+
npm run cli -- list liked --sort date --limit 10
76+
```
77+
78+
### Command Options
79+
80+
| Option | Description | Default | Example |
81+
|--------|-------------|---------|---------|
82+
| `--filter <query>` | Filter by configuration title | None | `--filter "frontend"` |
83+
| `--sort <field>` | Sort by date or name | `date` | `--sort name` |
84+
| `--limit <n>` | Limit results (1-100) | `20` | `--limit 50` |
85+
86+
### Output Format
87+
88+
The list command displays configurations in a table format:
89+
90+
```
91+
ID Title Created Size Access
92+
─────────────────────────────────────────────────────────────
93+
abc12345 Frontend React Setup 2 days ago 2.3MB Public
94+
def67890 TypeScript Backend 1 week ago 1.8MB Public
95+
ghi11121 Full Stack Template 3 days ago 4.1MB Public
96+
```
97+
98+
### Error Handling
99+
100+
The list command provides specific error messages for different scenarios:
101+
102+
- **Network Error**: "Unable to connect to Taptik cloud. Please check your internet connection."
103+
- **Authentication Error**: "Authentication failed. Please run 'taptik login' first."
104+
- **Server Error**: "Taptik cloud is temporarily unavailable. Please try again later."
105+
- **Invalid Options**: Shows help with valid options
106+
107+
### Authentication Requirements
108+
109+
- **Public listings**: No authentication required
110+
- **Liked configurations**: Requires authentication with `taptik login`
111+
40112
## 🏗️ Build Command Deep Dive
41113

42114
### Architecture Overview
@@ -117,6 +189,12 @@ npm run cli -- build --platform kiro --output ./dist/taptik-config --quiet
117189
npm run cli -- build --categories personal # User context only
118190
npm run cli -- build --categories project # Project context only
119191
npm run cli -- build --categories prompts # Templates only
192+
193+
# 6. List available configurations
194+
npm run cli -- list # List public configurations
195+
npm run cli -- list --filter "frontend" # Filter by title
196+
npm run cli -- list --sort name --limit 50 # Sort and limit results
197+
npm run cli -- list liked # List liked configurations (requires auth)
120198
```
121199

122200
### Advanced Options

README.md

Lines changed: 60 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,16 +262,73 @@ taptik pull --latest --target cursor
262262
taptik pull --dry-run # Preview without applying
263263
```
264264

265+
### List Command
266+
267+
The `list` command helps you discover and explore configuration packages available in the Taptik cloud.
268+
269+
#### Basic Usage
270+
271+
```bash
272+
# List all public configurations
273+
taptik list
274+
275+
# Filter configurations by title
276+
taptik list --filter "frontend"
277+
taptik list --filter "typescript setup"
278+
279+
# Sort configurations
280+
taptik list --sort date # Sort by creation date (default)
281+
taptik list --sort name # Sort alphabetically by title
282+
283+
# Limit number of results
284+
taptik list --limit 10 # Show 10 results
285+
taptik list --limit 50 # Show up to 50 results (max: 100)
286+
287+
# Combine options for precise discovery
288+
taptik list --filter "react" --sort name --limit 20
289+
```
290+
291+
#### Subcommands
292+
293+
```bash
294+
# List configurations you've liked (requires authentication)
295+
taptik list liked
296+
taptik list liked --sort date --limit 10
297+
```
298+
299+
#### Command Options
300+
301+
| Option | Description | Default | Valid Values |
302+
|--------|-------------|---------|--------------|
303+
| `--filter <query>` | Filter by configuration title | None | Any string |
304+
| `--sort <field>` | Sort results | `date` | `date`, `name` |
305+
| `--limit <n>` | Limit number of results | `20` | 1-100 |
306+
307+
#### Output Format
308+
309+
Results are displayed in a clean table format showing:
310+
- **ID**: Short identifier for the configuration
311+
- **Title**: Configuration name/title
312+
- **Created**: When the configuration was created (relative time)
313+
- **Size**: File size of the configuration package
314+
- **Access**: Whether the configuration is Public or Private
315+
316+
#### Authentication
317+
318+
- **Public listings**: No authentication required
319+
- **Liked configurations**: Requires login with `taptik login`
320+
265321
### Information & Discovery
266322

267323
```bash
268324
# Show current status
269325
taptik info
270326

271327
# List available configurations
272-
taptik list
273-
taptik list --filter "typescript"
274-
taptik list --sort date --limit 10
328+
taptik list # List all public configurations
329+
taptik list --filter "typescript" # Filter by title
330+
taptik list --sort name --limit 10 # Sort alphabetically, limit results
331+
taptik list liked # List your liked configurations (requires auth)
275332

276333
# Version information
277334
taptik --version

0 commit comments

Comments
 (0)