mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
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 -->
This commit is contained in:
parent
de4c247b9f
commit
8e03677aad
@ -75,12 +75,7 @@ To install Stack Auth in your Next.js project (for React, JavaScript, or other f
|
||||
|
||||
1. Run Stack Auth's installation wizard with the following command:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
```
|
||||
|
||||
If you prefer not to open a browser during setup (useful for CI/CD environments or restricted environments):
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest --no-browser
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
@ -63,10 +63,10 @@ export default function SetupPage(props: { toMetrics: () => void }) {
|
||||
</Typography>
|
||||
<CodeBlock
|
||||
language="bash"
|
||||
content={`npx @stackframe/init-stack@latest`}
|
||||
content={`npx @stackframe/stack-cli@latest init`}
|
||||
customRender={
|
||||
<div className="p-4 font-mono text-sm">
|
||||
<span className={commandClasses}>pnpx</span> <span className={nameClasses}>@stackframe/init-stack@latest</span>
|
||||
<span className={commandClasses}>pnpx</span> <span className={nameClasses}>@stackframe/stack-cli@latest</span> init
|
||||
</div>
|
||||
}
|
||||
title="Terminal"
|
||||
|
||||
@ -6,7 +6,7 @@ export const setupExamples = {
|
||||
{
|
||||
language: 'JavaScript',
|
||||
framework: 'Next.js',
|
||||
code: `npx @stackframe/init-stack@latest`,
|
||||
code: `npx @stackframe/stack-cli@latest init`,
|
||||
highlightLanguage: 'bash',
|
||||
filename: 'Terminal'
|
||||
}
|
||||
|
||||
@ -33,7 +33,7 @@ We recommend using our **setup wizard** for JavaScript frameworks for a seamless
|
||||
Run Stack's installation wizard with the following command:
|
||||
|
||||
```sh title="Terminal"
|
||||
npx @stackframe/init-stack@latest
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
|
||||
<Step>
|
||||
|
||||
@ -21,7 +21,7 @@ Next, install Stack Auth using the setup wizard:
|
||||
|
||||
```bash
|
||||
cd my-app/ # replace with your app name
|
||||
npx @stackframe/init-stack@latest
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
|
||||
### 3) Create a Stack Auth project
|
||||
|
||||
@ -53,7 +53,7 @@ Now let's create a new Next.js project and install Stack Auth and Supabase clien
|
||||
```bash title="Terminal"
|
||||
npx create-next-app@latest -e with-supabase stack-supabase
|
||||
cd stack-supabase
|
||||
npx @stackframe/init-stack@latest
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
|
||||
Now copy the environment variables from the Supabase dashboard to the `.env.local` file:
|
||||
|
||||
@ -24,11 +24,11 @@ Before proceeding, you MUST identify the project framework:
|
||||
- Call the tool or run the command:
|
||||
- **For Next.js projects**:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest --on-question error
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
- **For React projects**:
|
||||
- **For React projects**:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest --react --on-question error
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
- Accept defaults for Next.js (App Router) or React.
|
||||
- Add all generated files to the repo.
|
||||
|
||||
@ -12,7 +12,7 @@ We support Next.js frontends, along with any backend that can use our [REST API]
|
||||
|
||||
1. Run Stack Auth's installation wizard with the following command:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
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:
|
||||
```
|
||||
|
||||
@ -7,7 +7,7 @@ This component is the official way to integrate Stack Auth with your Convex proj
|
||||
To get started, first install Stack Auth using the setup wizard:
|
||||
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
npx @stackframe/stack-cli@latest init
|
||||
```
|
||||
|
||||
## Get Started
|
||||
|
||||
Loading…
Reference in New Issue
Block a user