clerk 3.3.1-canary.0af7dde → 3.4.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 +55 -17
- package/package.json +23 -11
package/README.md
CHANGED
|
@@ -2,6 +2,44 @@
|
|
|
2
2
|
|
|
3
3
|
The Clerk command-line interface.
|
|
4
4
|
|
|
5
|
+
## Add Clerk to an app
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npx -y clerk@latest init
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
`clerk init` is the setup path for developers and coding agents. It detects the
|
|
12
|
+
framework, installs the matching Clerk SDK for npm-based projects when it is
|
|
13
|
+
missing, and scaffolds the Clerk wiring it can safely generate.
|
|
14
|
+
|
|
15
|
+
For accountless-capable frameworks (Next.js, Astro, Nuxt, TanStack Start, and
|
|
16
|
+
React Router), unauthenticated agent runs can start without a Clerk account or
|
|
17
|
+
browser login. With no `--app` and no linked project, a first `clerk init` run
|
|
18
|
+
creates an unclaimed development application, writes local development keys, and
|
|
19
|
+
stores a claim breadcrumb for a later `clerk auth login`. Later runs keep an
|
|
20
|
+
existing unclaimed application instead of replacing it, unless you pass
|
|
21
|
+
`--fresh`. Frameworks without accountless
|
|
22
|
+
support need an authenticated app target before keys can be pulled: pass
|
|
23
|
+
`--app <id>`, use a linked project, or run `npx -y clerk@latest init --login`
|
|
24
|
+
in an interactive terminal to log in and link one.
|
|
25
|
+
|
|
26
|
+
What `clerk init` changes:
|
|
27
|
+
|
|
28
|
+
- Installs missing Clerk SDK packages in npm-based projects.
|
|
29
|
+
- Creates or updates supported framework files, such as provider wiring,
|
|
30
|
+
middleware or proxy files, and sign-in/sign-up routes.
|
|
31
|
+
- Writes Clerk keys to an env file when a real or accountless app is available.
|
|
32
|
+
- When it creates a new accountless application, writes `.clerk/keyless.json`
|
|
33
|
+
and adds `.clerk/` to `.gitignore`.
|
|
34
|
+
- In npm-based projects, offers to install Clerk agent skills; agent mode runs
|
|
35
|
+
that step non-interactively unless `--no-skills` is passed.
|
|
36
|
+
|
|
37
|
+
After setup, run `clerk doctor` to verify the integration:
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
npx -y clerk@latest doctor
|
|
41
|
+
```
|
|
42
|
+
|
|
5
43
|
## Installation
|
|
6
44
|
|
|
7
45
|
### Homebrew (macOS / Linux)
|
|
@@ -24,37 +62,37 @@ Usage: clerk [options] [command]
|
|
|
24
62
|
Clerk CLI
|
|
25
63
|
|
|
26
64
|
Options:
|
|
27
|
-
-
|
|
65
|
+
-h, --help Display help for command
|
|
28
66
|
--input-json <json> Pass command options as a JSON string, @file.json, or -
|
|
29
67
|
for stdin
|
|
30
68
|
--mode <mode> Force interaction mode (human or agent). Defaults to
|
|
31
69
|
auto-detect based on TTY.
|
|
70
|
+
-v, --version Output the version number
|
|
32
71
|
--verbose Show detailed output (enables debug messages)
|
|
33
|
-
-h, --help Display help for command
|
|
34
72
|
|
|
35
73
|
Commands:
|
|
36
|
-
|
|
37
|
-
auth Manage authentication
|
|
38
|
-
link [options] Link this project to a Clerk application
|
|
39
|
-
unlink [options] Unlink this project from its Clerk application
|
|
40
|
-
whoami [options] Show the current logged-in user and linked application
|
|
41
|
-
open Open Clerk resources in your browser
|
|
74
|
+
api [options] [endpoint] [filter] Call any Clerk API endpoint (200+; `clerk api ls` to browse)
|
|
42
75
|
apps Manage your Clerk applications
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
env Manage environment variables
|
|
76
|
+
auth Manage authentication
|
|
77
|
+
completion [shell] Generate shell autocompletion script
|
|
46
78
|
config Manage instance configuration
|
|
47
|
-
|
|
48
|
-
enable Enable Clerk features on the linked instance
|
|
79
|
+
deploy Deploy a Clerk application to production
|
|
49
80
|
disable Disable Clerk features on the linked instance
|
|
50
|
-
api [options] [endpoint] [filter] Call any Clerk API endpoint (200+; `clerk api ls` to browse)
|
|
51
81
|
doctor [options] Check your project's Clerk integration health
|
|
82
|
+
enable Enable Clerk features on the linked instance
|
|
83
|
+
env Manage environment variables
|
|
84
|
+
help [command] Display help for command
|
|
85
|
+
impersonate|imp [options] [user] Impersonate a Clerk user
|
|
86
|
+
init [options] Initialize Clerk in your project
|
|
87
|
+
link [options] Link this project to a Clerk application
|
|
52
88
|
mcp Manage the Clerk remote MCP server connection for AI editors and CLIs
|
|
53
|
-
|
|
89
|
+
open Open Clerk resources in your browser
|
|
90
|
+
telemetry Control CLI usage telemetry (status, disable, enable)
|
|
91
|
+
unlink [options] Unlink this project from its Clerk application
|
|
54
92
|
update [options] Update the Clerk CLI to the latest version
|
|
55
|
-
|
|
93
|
+
users [options] Manage Clerk users
|
|
56
94
|
webhooks Stream webhook events to a local handler and verify their signatures
|
|
57
|
-
|
|
95
|
+
whoami [options] Show the current logged-in user and linked application
|
|
58
96
|
bird Play Clerk Bird, a Flappy Bird game in your terminal
|
|
59
97
|
```
|
|
60
98
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "clerk",
|
|
3
|
-
"version": "3.
|
|
4
|
-
"description": "Clerk CLI",
|
|
3
|
+
"version": "3.4.0",
|
|
4
|
+
"description": "The official Clerk CLI. Add authentication to your app with npx -y clerk@latest init (Next.js, React Router, Astro, Nuxt, TanStack Start, Expo, and more). No Clerk account needed to start. Manage users, instances, keys, and deploys from the terminal or a coding agent.",
|
|
5
5
|
"keywords": [
|
|
6
|
+
"accountless",
|
|
7
|
+
"ai-agent",
|
|
8
|
+
"auth",
|
|
6
9
|
"authentication",
|
|
7
10
|
"clerk",
|
|
8
|
-
"cli"
|
|
11
|
+
"clerk-cli",
|
|
12
|
+
"cli",
|
|
13
|
+
"coding-agent",
|
|
14
|
+
"expo",
|
|
15
|
+
"keyless",
|
|
16
|
+
"mcp",
|
|
17
|
+
"nextjs",
|
|
18
|
+
"oauth",
|
|
19
|
+
"react",
|
|
20
|
+
"user-management"
|
|
9
21
|
],
|
|
10
22
|
"homepage": "https://clerk.com/docs",
|
|
11
23
|
"bugs": {
|
|
@@ -30,13 +42,13 @@
|
|
|
30
42
|
"node": ">=20.0.0"
|
|
31
43
|
},
|
|
32
44
|
"optionalDependencies": {
|
|
33
|
-
"@clerk/cli-darwin-arm64": "3.
|
|
34
|
-
"@clerk/cli-darwin-x64": "3.
|
|
35
|
-
"@clerk/cli-linux-arm64": "3.
|
|
36
|
-
"@clerk/cli-linux-arm64-musl": "3.
|
|
37
|
-
"@clerk/cli-linux-x64": "3.
|
|
38
|
-
"@clerk/cli-linux-x64-musl": "3.
|
|
39
|
-
"@clerk/cli-win32-arm64": "3.
|
|
40
|
-
"@clerk/cli-win32-x64": "3.
|
|
45
|
+
"@clerk/cli-darwin-arm64": "3.4.0",
|
|
46
|
+
"@clerk/cli-darwin-x64": "3.4.0",
|
|
47
|
+
"@clerk/cli-linux-arm64": "3.4.0",
|
|
48
|
+
"@clerk/cli-linux-arm64-musl": "3.4.0",
|
|
49
|
+
"@clerk/cli-linux-x64": "3.4.0",
|
|
50
|
+
"@clerk/cli-linux-x64-musl": "3.4.0",
|
|
51
|
+
"@clerk/cli-win32-arm64": "3.4.0",
|
|
52
|
+
"@clerk/cli-win32-x64": "3.4.0"
|
|
41
53
|
}
|
|
42
54
|
}
|