Skip to content

Commit 8e03677

Browse files
authored
change cli init across docs (#1245)
<!-- Make sure you've read the CONTRIBUTING.md guidelines: https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated installation and setup instructions across all documentation, README files, and getting started guides to use the new Stack CLI command format for project initialization. Users will now see the updated command throughout documentation and framework-specific setup guides. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent de4c247 commit 8e03677

File tree

9 files changed

+12
-17
lines changed

9 files changed

+12
-17
lines changed

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,7 @@ To install Stack Auth in your Next.js project (for React, JavaScript, or other f
7575

7676
1. Run Stack Auth's installation wizard with the following command:
7777
```bash
78-
npx @stackframe/init-stack@latest
79-
```
80-
81-
If you prefer not to open a browser during setup (useful for CI/CD environments or restricted environments):
82-
```bash
83-
npx @stackframe/init-stack@latest --no-browser
78+
npx @stackframe/stack-cli@latest init
8479
```
8580

8681
2. Then, create an account on the [Stack Auth dashboard](https://app.stack-auth.com/projects), create a new project with an API key, and copy its environment variables into the .env.local file of your Next.js project:

apps/dashboard/src/app/(main)/(protected)/projects/[projectId]/(overview)/setup-page.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ export default function SetupPage(props: { toMetrics: () => void }) {
6363
</Typography>
6464
<CodeBlock
6565
language="bash"
66-
content={`npx @stackframe/init-stack@latest`}
66+
content={`npx @stackframe/stack-cli@latest init`}
6767
customRender={
6868
<div className="p-4 font-mono text-sm">
69-
<span className={commandClasses}>pnpx</span> <span className={nameClasses}>@stackframe/init-stack@latest</span>
69+
<span className={commandClasses}>pnpx</span> <span className={nameClasses}>@stackframe/stack-cli@latest</span> init
7070
</div>
7171
}
7272
title="Terminal"

docs/code-examples/setup.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const setupExamples = {
66
{
77
language: 'JavaScript',
88
framework: 'Next.js',
9-
code: `npx @stackframe/init-stack@latest`,
9+
code: `npx @stackframe/stack-cli@latest init`,
1010
highlightLanguage: 'bash',
1111
filename: 'Terminal'
1212
}

docs/content/docs/(guides)/getting-started/setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ We recommend using our **setup wizard** for JavaScript frameworks for a seamless
3333
Run Stack's installation wizard with the following command:
3434

3535
```sh title="Terminal"
36-
npx @stackframe/init-stack@latest
36+
npx @stackframe/stack-cli@latest init
3737
```
3838

3939
<Step>

docs/content/docs/(guides)/others/convex.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Next, install Stack Auth using the setup wizard:
2121

2222
```bash
2323
cd my-app/ # replace with your app name
24-
npx @stackframe/init-stack@latest
24+
npx @stackframe/stack-cli@latest init
2525
```
2626

2727
### 3) Create a Stack Auth project

docs/content/docs/(guides)/others/supabase.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Now let's create a new Next.js project and install Stack Auth and Supabase clien
5353
```bash title="Terminal"
5454
npx create-next-app@latest -e with-supabase stack-supabase
5555
cd stack-supabase
56-
npx @stackframe/init-stack@latest
56+
npx @stackframe/stack-cli@latest init
5757
```
5858

5959
Now copy the environment variables from the Supabase dashboard to the `.env.local` file:

docs/src/app/api/internal/[transport]/setup-instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Before proceeding, you MUST identify the project framework:
2424
- Call the tool or run the command:
2525
- **For Next.js projects**:
2626
```bash
27-
npx @stackframe/init-stack@latest --on-question error
27+
npx @stackframe/stack-cli@latest init
2828
```
29-
- **For React projects**:
29+
- **For React projects**:
3030
```bash
31-
npx @stackframe/init-stack@latest --react --on-question error
31+
npx @stackframe/stack-cli@latest init
3232
```
3333
- Accept defaults for Next.js (App Router) or React.
3434
- Add all generated files to the repo.

packages/template/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We support Next.js frontends, along with any backend that can use our [REST API]
1212

1313
1. Run Stack Auth's installation wizard with the following command:
1414
```bash
15-
npx @stackframe/init-stack@latest
15+
npx @stackframe/stack-cli@latest init
1616
```
1717
2. Then, create an account on the [Stack Auth dashboard](https://app.stack-auth.com/projects), create a new project with an API key, and copy its environment variables into the .env.local file of your Next.js project:
1818
```

packages/template/src/integrations/convex/component/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This component is the official way to integrate Stack Auth with your Convex proj
77
To get started, first install Stack Auth using the setup wizard:
88

99
```bash
10-
npx @stackframe/init-stack@latest
10+
npx @stackframe/stack-cli@latest init
1111
```
1212

1313
## Get Started

0 commit comments

Comments
 (0)