@pickled-dev/cli 0.1.0 β 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -76
- package/dist/index.js +217 -108
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -2,122 +2,109 @@
|
|
|
2
2
|
|
|
3
3
|
> Stay fresh in AI π₯
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
Pickled checks how often AI models actually recommend your tool when developers ask questions. Point it at a GitHub repo, and we'll tell you if you're well preservedβor starting to spoil.
|
|
5
|
+
Check if AI recommends your developer tool. Point it at your project, define some discovery scenarios, and see if you're getting picked.
|
|
8
6
|
|
|
9
7
|
## Installation
|
|
10
8
|
|
|
11
9
|
```bash
|
|
12
|
-
# Global install
|
|
13
10
|
bun add -g @pickled-dev/cli
|
|
14
|
-
|
|
15
|
-
# Or run directly
|
|
16
|
-
bunx @pickled-dev/cli check github.com/org/repo
|
|
17
11
|
```
|
|
18
12
|
|
|
19
|
-
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
### 1. Initialize config
|
|
20
16
|
|
|
21
17
|
```bash
|
|
22
|
-
|
|
18
|
+
pickled init
|
|
23
19
|
```
|
|
24
20
|
|
|
25
|
-
|
|
21
|
+
Creates a `pickled.yml` file:
|
|
26
22
|
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
|
|
23
|
+
```yaml
|
|
24
|
+
tool:
|
|
25
|
+
name: "your-tool"
|
|
26
|
+
description: "What your tool does"
|
|
27
|
+
keywords:
|
|
28
|
+
- keyword1
|
|
29
|
+
- keyword2
|
|
30
|
+
|
|
31
|
+
scenarios:
|
|
32
|
+
- name: "General discovery"
|
|
33
|
+
prompt: "What's a good library for [your use case]?"
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
- name: "Specific feature"
|
|
36
|
+
prompt: "I need a tool that can [specific feature]. What should I use?"
|
|
37
|
+
```
|
|
32
38
|
|
|
33
|
-
###
|
|
39
|
+
### 2. Edit your config
|
|
34
40
|
|
|
35
|
-
|
|
36
|
-
|------|--------------|
|
|
37
|
-
| `--json` | Output as fresh JSON |
|
|
38
|
-
| `-o, --output <file>` | Save your freshness report (.json or .xml) |
|
|
39
|
-
| `-v, --verbose` | Show the full pickling process |
|
|
40
|
-
| `-c, --competitors <list>` | Bring your own shelf mates (skip auto-discovery) |
|
|
41
|
+
Update `pickled.yml` with your actual tool info and scenarios that developers might ask.
|
|
41
42
|
|
|
42
|
-
###
|
|
43
|
+
### 3. Run check
|
|
43
44
|
|
|
44
45
|
```bash
|
|
45
|
-
|
|
46
|
-
|
|
46
|
+
pickled check
|
|
47
|
+
```
|
|
47
48
|
|
|
48
|
-
|
|
49
|
-
pickled check github.com/colinhacks/zod -c "yup,joi,valibot"
|
|
49
|
+
## Commands
|
|
50
50
|
|
|
51
|
-
|
|
52
|
-
pickled check github.com/colinhacks/zod -o report.json
|
|
51
|
+
### `pickled init [path]`
|
|
53
52
|
|
|
54
|
-
|
|
55
|
-
pickled check github.com/colinhacks/zod -v
|
|
56
|
-
```
|
|
53
|
+
Create a starter `pickled.yml` config file.
|
|
57
54
|
|
|
58
|
-
|
|
55
|
+
### `pickled check [path]`
|
|
59
56
|
|
|
60
|
-
|
|
61
|
-
π₯ Freshness Report: zod
|
|
62
|
-
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
57
|
+
Run discovery scenarios and report results.
|
|
63
58
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
59
|
+
| Option | Description |
|
|
60
|
+
| --------------------- | ---------------------- |
|
|
61
|
+
| `--json` | Output as JSON |
|
|
62
|
+
| `-o, --output <file>` | Save report to file |
|
|
63
|
+
| `-v, --verbose` | Show detailed progress |
|
|
67
64
|
|
|
68
|
-
|
|
69
|
-
|
|
65
|
+
## Example Output
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
π₯ pickled check results
|
|
70
69
|
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
71
70
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
ββ yup: 5/10 (50%)
|
|
75
|
-
ββ joi: 2/10 (20%)
|
|
71
|
+
Tool: zod
|
|
72
|
+
Path: /path/to/zod
|
|
76
73
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
ββ yup: 3/10 (30%)
|
|
74
|
+
β "Validation library" - passed
|
|
75
|
+
β "Schema validation" - passed
|
|
76
|
+
β "Form validation" - tool not mentioned
|
|
81
77
|
|
|
82
78
|
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
83
|
-
|
|
84
|
-
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
85
|
-
|
|
86
|
-
Overall freshness: 75% - Looking Fresh π₯
|
|
87
|
-
Top of the shelf in: 2/2 topics
|
|
79
|
+
Freshness: 2/3 (67%) π₯π₯π₯ββ
|
|
88
80
|
|
|
89
|
-
π₯
|
|
90
|
-
Stay fresh! π₯
|
|
81
|
+
π₯ Not bad, but room to get fresher.
|
|
91
82
|
```
|
|
92
83
|
|
|
93
|
-
##
|
|
84
|
+
## Config Reference
|
|
94
85
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
86
|
+
```yaml
|
|
87
|
+
tool:
|
|
88
|
+
name: "tool-name" # Required: your tool's name
|
|
89
|
+
description: "description" # Required: what it does
|
|
90
|
+
keywords: # Required: relevant keywords
|
|
91
|
+
- keyword1
|
|
92
|
+
- keyword2
|
|
101
93
|
|
|
102
|
-
|
|
94
|
+
scenarios: # Required: discovery scenarios
|
|
95
|
+
- name: "Scenario name" # Display name
|
|
96
|
+
prompt: "The question" # What to ask AI
|
|
103
97
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
98
|
+
runner: # Optional: customize AI runner
|
|
99
|
+
model: claude-sonnet-4-20250514
|
|
100
|
+
maxTurns: 3
|
|
101
|
+
```
|
|
107
102
|
|
|
108
103
|
## Local Development
|
|
109
104
|
|
|
110
105
|
```bash
|
|
111
106
|
# From the monorepo root
|
|
112
107
|
bun install
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
cp apps/cli/.env.example .env
|
|
116
|
-
|
|
117
|
-
# Run the CLI
|
|
118
|
-
bun dev:cli check github.com/org/repo
|
|
108
|
+
bun run dev:cli -- init
|
|
109
|
+
bun run dev:cli -- check
|
|
119
110
|
```
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
Built with π₯ by the Pickled team
|