diff --git a/content/cli/connect.md b/content/cli/connect.md index 8dd7d12..18ac78d 100644 --- a/content/cli/connect.md +++ b/content/cli/connect.md @@ -10,12 +10,20 @@ linked to it, in one command. Install the CLI first, because you keep using it to build and deploy after `connect`. See [installation.md](installation.md) for other ways to install. +New to Volcano: + ```bash npm install -g @volcano.dev/cli -volcano connect +volcano connect --signup ``` -Run it yourself, or paste both lines into a coding agent. +Already have an account? Run `volcano connect` instead. + +Run it yourself, or paste this prompt into a coding agent: + +```text +Run `npm i -g @volcano.dev/cli && volcano connect --signup` and keep it running while I sign up. +``` It runs these steps. A rerun inside the linked directory, or with the same directory argument, keeps the project and updates the files in place. A rerun @@ -29,7 +37,9 @@ characters in single quotes, so you can paste them as they are. 1. **Signs in.** It signs in with `--device-code` when given. Otherwise it reuses a login that still works, or runs browser login. Browser login prints a code and a link. Open the link and approve, and the - command continues. See + command continues. That page signs in an existing account with GitHub, + Google, or email and password. It can't create an account by email, so + run `volcano connect --signup` if you're new. See [Device codes from the dashboard](#device-codes-from-the-dashboard). 2. **Creates a project and its directory.** Unless `--project` names one, or the directory is already linked, it creates a new project. diff --git a/content/get-started/quickstart.md b/content/get-started/quickstart.md index 931d0f5..0d1819e 100644 --- a/content/get-started/quickstart.md +++ b/content/get-started/quickstart.md @@ -4,8 +4,8 @@ description: Install the CLI, sign up, create a project, and start building. order: 3 --- -This gets you an account and an active project. From there, follow the -surface-specific quickstart for what you are building. +This gets you an account and a project linked to a local directory. From +there, follow the surface-specific quickstart for what you are building. ## 1. Install the CLI @@ -15,24 +15,29 @@ npm install -g @volcano.dev/cli See [install](./install.md) for other methods. -## 2. Sign up +## 2. Sign up and create a project ```bash -volcano signup +volcano connect --signup ``` -This prefills your email, opens the browser signup flow, and saves your -credentials to `~/.volcano/config.json` — one command signs you up and logs -you in. +This opens the browser signup page with your global git email filled in. +If that email is missing or private (such as a GitHub `noreply` address), +`connect` stops and asks for one: run it again with +`--email you@company.com`. When you finish signing up, the CLI is signed in, +creates a cloud project, and sets up a directory linked to it. `cd` into the +directory it prints before you run other `volcano` commands. -## 3. Create and select a project +Already have an account? Use the log-in link on the signup page, or run +`volcano connect` instead. See [connect](/cli/connect) for the details. -```bash -volcano projects create my-first-project -volcano use my-first-project +To have a coding agent do it, paste this prompt: + +```text +Run `npm i -g @volcano.dev/cli && volcano connect --signup` and keep it running while I sign up. ``` -## 4. Build +## 3. Build Pick your path: