clerk 1.0.4-snapshot.61503f6 → 1.1.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 +13 -182
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -24,203 +24,34 @@ Usage: clerk [options] [command]
|
|
|
24
24
|
Clerk CLI
|
|
25
25
|
|
|
26
26
|
Options:
|
|
27
|
-
-v, --version
|
|
28
|
-
--
|
|
29
|
-
|
|
30
|
-
--
|
|
31
|
-
|
|
27
|
+
-v, --version Output the version number
|
|
28
|
+
--input-json <json> Pass command options as a JSON string, @file.json, or -
|
|
29
|
+
for stdin
|
|
30
|
+
--mode <mode> Force interaction mode (human or agent). Defaults to
|
|
31
|
+
auto-detect based on TTY.
|
|
32
|
+
--verbose Show detailed output (enables debug messages)
|
|
33
|
+
-h, --help Display help for command
|
|
32
34
|
|
|
33
35
|
Commands:
|
|
34
36
|
init [options] Initialize Clerk in your project
|
|
35
37
|
auth Manage authentication
|
|
36
|
-
login|signup Log in to your Clerk account
|
|
37
|
-
logout|signout Log out of your Clerk account
|
|
38
38
|
link [options] Link this project to a Clerk application
|
|
39
39
|
unlink [options] Unlink this project from its Clerk application
|
|
40
40
|
whoami Show the current logged-in user
|
|
41
41
|
open Open Clerk resources in your browser
|
|
42
|
-
dashboard [options] [subpath] Open the linked app's dashboard
|
|
43
42
|
apps Manage your Clerk applications
|
|
44
|
-
|
|
45
|
-
create [options] <name> Create a new Clerk application
|
|
46
|
-
config Manage instance configuration
|
|
47
|
-
pull [options] Pull instance configuration from Clerk
|
|
48
|
-
schema [options] Pull instance config schema from Clerk
|
|
49
|
-
patch [options] Partially update instance configuration (PATCH)
|
|
50
|
-
put [options] Replace entire instance configuration (PUT)
|
|
43
|
+
users [options] Manage Clerk users
|
|
51
44
|
env Manage environment variables
|
|
52
|
-
|
|
45
|
+
config Manage instance configuration
|
|
46
|
+
enable Enable Clerk features on the linked instance
|
|
47
|
+
disable Disable Clerk features on the linked instance
|
|
53
48
|
api [options] [endpoint] [filter] Make authenticated requests to the Clerk API
|
|
54
|
-
ls [filter] List available API endpoints
|
|
55
|
-
(no args) Interactive request builder (TTY only)
|
|
56
49
|
doctor [options] Check your project's Clerk integration health
|
|
57
|
-
skill Manage the bundled Clerk CLI agent skill
|
|
58
|
-
install [options] Install the bundled clerk agent skill
|
|
59
|
-
switch-env [environment] Switch the active Clerk CLI environment
|
|
60
50
|
completion [shell] Generate shell autocompletion script
|
|
51
|
+
skill Manage the bundled Clerk CLI agent skill
|
|
61
52
|
update [options] Update the Clerk CLI to the latest version
|
|
53
|
+
help [command] Display help for command
|
|
62
54
|
|
|
63
55
|
Give AI agents better Clerk context: install the Clerk skills
|
|
64
56
|
$ clerk skill install
|
|
65
|
-
|
|
66
|
-
clerk init
|
|
67
|
-
--framework <name> Framework to set up (skips auto-detection)
|
|
68
|
-
--pm <manager> Package manager to use (skips prompt/auto-detection)
|
|
69
|
-
--name <project-name> Project name for --starter (skips prompt)
|
|
70
|
-
--app <id> Application ID to link (skips interactive picker)
|
|
71
|
-
--starter Bootstrap a new project from a starter template
|
|
72
|
-
--prompt Output a prompt for an AI agent to integrate Clerk
|
|
73
|
-
--yes Skip confirmation prompts
|
|
74
|
-
--no-skills Skip the optional agent skills install prompt
|
|
75
|
-
Examples:
|
|
76
|
-
$ clerk init Auto-detect framework and set up Clerk
|
|
77
|
-
$ clerk init --framework next Set up for Next.js (skips detection)
|
|
78
|
-
$ clerk init --app app_123 Link to a specific Clerk application
|
|
79
|
-
$ clerk init --starter Create a new project with Clerk
|
|
80
|
-
$ clerk init --starter --framework next --pm bun Bootstrap with Bun
|
|
81
|
-
$ clerk init --prompt Output a setup prompt for an AI agent
|
|
82
|
-
$ clerk init -y Skip all confirmation prompts
|
|
83
|
-
$ clerk init --no-skills Skip the agent skills install prompt
|
|
84
|
-
|
|
85
|
-
clerk auth login Log in via browser (OAuth)
|
|
86
|
-
clerk auth logout Remove stored credentials
|
|
87
|
-
|
|
88
|
-
clerk link
|
|
89
|
-
--app <id> Application ID to link (skips interactive picker)
|
|
90
|
-
Examples:
|
|
91
|
-
$ clerk link Pick an app interactively
|
|
92
|
-
$ clerk link --app app_abc123 Link directly by application ID
|
|
93
|
-
|
|
94
|
-
clerk unlink
|
|
95
|
-
--yes Skip confirmation prompt
|
|
96
|
-
Examples:
|
|
97
|
-
$ clerk unlink Unlink with confirmation prompt
|
|
98
|
-
$ clerk unlink --yes Skip confirmation
|
|
99
|
-
|
|
100
|
-
clerk whoami Show your email address
|
|
101
|
-
|
|
102
|
-
clerk open [subpath]
|
|
103
|
-
--print Print the URL without opening the browser
|
|
104
|
-
Examples:
|
|
105
|
-
$ clerk open Open the linked app's dashboard
|
|
106
|
-
$ clerk open users Open the users page
|
|
107
|
-
$ clerk open api-keys Open the API keys page
|
|
108
|
-
$ clerk open --print Print the dashboard URL
|
|
109
|
-
|
|
110
|
-
clerk config pull
|
|
111
|
-
--app <id> Application ID to target (works from any directory)
|
|
112
|
-
--instance <id> Instance to target (dev, prod, or a full instance ID)
|
|
113
|
-
--output <file> Write config to a file instead of stdout
|
|
114
|
-
Examples:
|
|
115
|
-
$ clerk config pull Print dev config to stdout
|
|
116
|
-
$ clerk config pull --instance prod Pull production config
|
|
117
|
-
$ clerk config pull --output config.json Save config to a file
|
|
118
|
-
|
|
119
|
-
clerk config schema
|
|
120
|
-
--app <id> Application ID to target (works from any directory)
|
|
121
|
-
--instance <id> Instance to target (dev, prod, or a full instance ID)
|
|
122
|
-
--output <file> Write schema to a file instead of stdout
|
|
123
|
-
--keys <keys...> Config keys to retrieve schema for
|
|
124
|
-
Examples:
|
|
125
|
-
$ clerk config schema Print full config schema
|
|
126
|
-
$ clerk config schema --keys social_login Schema for specific keys
|
|
127
|
-
$ clerk config schema --output schema.json Save schema to a file
|
|
128
|
-
|
|
129
|
-
clerk config patch
|
|
130
|
-
--app <id> Application ID to target (works from any directory)
|
|
131
|
-
--instance <id> Instance to target (dev, prod, or a full instance ID)
|
|
132
|
-
--file <path> Read config JSON from a file
|
|
133
|
-
--json <string> Pass config JSON inline
|
|
134
|
-
--dry-run Show what would be sent without making the API call
|
|
135
|
-
--yes Skip confirmation prompts
|
|
136
|
-
Examples:
|
|
137
|
-
$ clerk config patch --file config.json Apply partial update from file
|
|
138
|
-
$ clerk config patch --json '{"key":"value"}' Inline JSON patch
|
|
139
|
-
$ clerk config patch --file config.json --dry-run Preview without applying
|
|
140
|
-
$ clerk config patch --instance prod --file config.json Patch production config
|
|
141
|
-
|
|
142
|
-
clerk config put
|
|
143
|
-
--app <id> Application ID to target (works from any directory)
|
|
144
|
-
--instance <id> Instance to target (dev, prod, or a full instance ID)
|
|
145
|
-
--file <path> Read config JSON from a file
|
|
146
|
-
--json <string> Pass config JSON inline
|
|
147
|
-
--dry-run Show what would be sent without making the API call
|
|
148
|
-
--yes Skip confirmation prompts
|
|
149
|
-
Examples:
|
|
150
|
-
$ clerk config put --file config.json Replace entire config from file
|
|
151
|
-
$ clerk config put --file config.json --dry-run Preview the replacement
|
|
152
|
-
$ clerk config put --instance prod --file config.json Replace production config
|
|
153
|
-
$ clerk config put --file config.json --yes Skip confirmation prompt
|
|
154
|
-
|
|
155
|
-
clerk env pull
|
|
156
|
-
--app <id> Application ID to target (works from any directory)
|
|
157
|
-
--instance <id> Instance to target (dev, prod, or a full instance ID)
|
|
158
|
-
--file <path> Target env file (default: auto-detect)
|
|
159
|
-
Examples:
|
|
160
|
-
$ clerk env pull Pull dev keys to .env.local
|
|
161
|
-
$ clerk env pull --instance prod Pull production keys
|
|
162
|
-
$ clerk env pull --file .env Write to a specific file
|
|
163
|
-
$ clerk env pull --app app_abc123 Target a specific application
|
|
164
|
-
|
|
165
|
-
clerk api [endpoint] [filter]
|
|
166
|
-
-X, --method <method> HTTP method (default: GET, or POST if body provided)
|
|
167
|
-
-d, --data <json> JSON request body
|
|
168
|
-
--file <path> Read request body from a file
|
|
169
|
-
--include Show response headers
|
|
170
|
-
--app <id> Application ID to target when resolving keys
|
|
171
|
-
--secret-key <key> Override the secret key
|
|
172
|
-
--instance <id> Instance to target (dev, prod, or instance ID)
|
|
173
|
-
--platform Use Platform API instead of Backend API
|
|
174
|
-
--dry-run Show the request without executing it
|
|
175
|
-
--yes Skip confirmation for mutating requests
|
|
176
|
-
Examples:
|
|
177
|
-
$ clerk api ls List all available endpoints
|
|
178
|
-
$ clerk api ls users List endpoints matching "users"
|
|
179
|
-
$ clerk api /users GET /v1/users
|
|
180
|
-
$ clerk api /users -d '{"first_name":"Alice"}' POST with a JSON body
|
|
181
|
-
|
|
182
|
-
clerk api ls [filter] List available API endpoints
|
|
183
|
-
clerk api Interactive request builder (TTY only)
|
|
184
|
-
|
|
185
|
-
clerk apps list
|
|
186
|
-
--json Output as JSON
|
|
187
|
-
|
|
188
|
-
clerk apps create <name>
|
|
189
|
-
--json Output as JSON
|
|
190
|
-
Examples:
|
|
191
|
-
$ clerk apps create "My App" Create a new application
|
|
192
|
-
$ clerk apps create "My App" --json Output as JSON
|
|
193
|
-
|
|
194
|
-
clerk doctor
|
|
195
|
-
--verbose Show detailed output for each check
|
|
196
|
-
--json Output results as JSON
|
|
197
|
-
--spotlight Only show warnings and failures
|
|
198
|
-
--fix Attempt to auto-fix issues
|
|
199
|
-
Examples:
|
|
200
|
-
$ clerk doctor Run all health checks
|
|
201
|
-
$ clerk doctor --verbose Show detailed output for each check
|
|
202
|
-
$ clerk doctor --json Output results as machine-readable JSON
|
|
203
|
-
$ clerk doctor --fix Auto-fix detected issues
|
|
204
|
-
$ clerk doctor --spotlight Only show warnings and failures
|
|
205
|
-
|
|
206
|
-
clerk skill install
|
|
207
|
-
-y, --yes Skip prompts and run the `skills` CLI unattended
|
|
208
|
-
--pm <manager> Package manager hint for runner detection
|
|
209
|
-
Examples:
|
|
210
|
-
$ clerk skill install Install with an interactive runner picker
|
|
211
|
-
$ clerk skill install -y Install unattended
|
|
212
|
-
$ clerk skill install --pm bun Force bunx as the runner
|
|
213
|
-
|
|
214
|
-
clerk completion <shell>
|
|
215
|
-
shell: bash, zsh, fish, powershell
|
|
216
|
-
|
|
217
|
-
clerk update
|
|
218
|
-
--channel <tag> Release channel to update to (e.g. latest, canary)
|
|
219
|
-
-y, --yes Skip confirmation prompt
|
|
220
|
-
--all Update every clerk install found on PATH, not just the first
|
|
221
|
-
Examples:
|
|
222
|
-
$ clerk update Update to the latest stable release
|
|
223
|
-
$ clerk update --channel canary Update to the latest canary release
|
|
224
|
-
$ clerk update --yes Update without confirmation prompt
|
|
225
|
-
$ clerk update --all Update every clerk install on PATH
|
|
226
57
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "clerk",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Clerk CLI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"authentication",
|
|
@@ -30,13 +30,13 @@
|
|
|
30
30
|
"node": ">=20.0.0"
|
|
31
31
|
},
|
|
32
32
|
"optionalDependencies": {
|
|
33
|
-
"@clerk/cli-darwin-arm64": "1.0
|
|
34
|
-
"@clerk/cli-darwin-x64": "1.0
|
|
35
|
-
"@clerk/cli-linux-arm64": "1.0
|
|
36
|
-
"@clerk/cli-linux-arm64-musl": "1.0
|
|
37
|
-
"@clerk/cli-linux-x64": "1.0
|
|
38
|
-
"@clerk/cli-linux-x64-musl": "1.0
|
|
39
|
-
"@clerk/cli-win32-arm64": "1.0
|
|
40
|
-
"@clerk/cli-win32-x64": "1.0
|
|
33
|
+
"@clerk/cli-darwin-arm64": "1.1.0",
|
|
34
|
+
"@clerk/cli-darwin-x64": "1.1.0",
|
|
35
|
+
"@clerk/cli-linux-arm64": "1.1.0",
|
|
36
|
+
"@clerk/cli-linux-arm64-musl": "1.1.0",
|
|
37
|
+
"@clerk/cli-linux-x64": "1.1.0",
|
|
38
|
+
"@clerk/cli-linux-x64-musl": "1.1.0",
|
|
39
|
+
"@clerk/cli-win32-arm64": "1.1.0",
|
|
40
|
+
"@clerk/cli-win32-x64": "1.1.0"
|
|
41
41
|
}
|
|
42
42
|
}
|