diff --git a/apps/docs/content/guides/cli.mdx b/apps/docs/content/guides/cli.mdx index 13297eba2c2..65484bc4c96 100644 --- a/apps/docs/content/guides/cli.mdx +++ b/apps/docs/content/guides/cli.mdx @@ -6,7 +6,7 @@ subtitle: 'Developing locally using the Supabase CLI.' sidebar_label: 'Overview' --- -You can use the Supabase CLI to run the entire Supabase stack locally on your machine, by running `supabase init` and then `supabase start`. To install the CLI, see the [installation guide](/docs/guides/cli/getting-started#installing-the-supabase-cli). +You can use the Supabase CLI to run the entire Supabase stack locally on your machine, by running `supabase init` and then `supabase start`. To install the CLI, read [the installation guide](/docs/guides/cli/getting-started#installing-the-supabase-cli). The Supabase CLI provides tools to develop your project locally, deploy to the Supabase Platform, handle database migrations, and generate types directly from your database schema. diff --git a/apps/docs/content/guides/local-development/cli/getting-started.mdx b/apps/docs/content/guides/local-development/cli/getting-started.mdx index eb4f2186b2e..8b531f49e4b 100644 --- a/apps/docs/content/guides/local-development/cli/getting-started.mdx +++ b/apps/docs/content/guides/local-development/cli/getting-started.mdx @@ -72,28 +72,12 @@ The Supabase CLI requires **Node.js 20 or later** when run via `npx` or `npm`. O - - -Installing the Supabase CLI globally using `npm install -g supabase` is **not supported**. - -For global usage, install the CLI via Homebrew, Scoop, or the standalone binary. - -Alternatively, you can run the CLI using `npx supabase` or install it locally as a dev dependency. - - - You can also install the CLI as dev dependency via [npm](https://www.npmjs.com/package/supabase): ```sh npm install supabase --save-dev ``` - - -Global installation using `npm install -g supabase` is not supported. For global CLI usage, install via [Homebrew](/docs/guides/local-development/cli/getting-started?queryGroups=platform&platform=macos), [Scoop](/docs/guides/local-development/cli/getting-started?queryGroups=platform&platform=windows), or the [standalone binary](/docs/guides/local-development/cli/getting-started?queryGroups=platform&platform=linux). - - - @@ -157,7 +141,7 @@ npx supabase@beta --help ## Updating the Supabase CLI -When a new [version](https://github.com/supabase/cli/releases) is released, you can update the CLI using the same methods. +When a new [version](https://github.com/supabase/cli/releases) is released, you can update the CLI using the same channels. - - -Docker settings on Mac: Select Integrated, Virtualization Framework, and osxfs - - - - -Docker settings on Windows: Select Integrated, Expose Daemon, WSL2, and Add to /etc/hosts file. - - - - - +The Supabase CLI uses Docker containers to manage the local development stack. Follow the official guide to install and configure [Docker Desktop](https://docs.docker.com/desktop) on your machine. Alternately, you can use a different container tool that offers Docker compatible APIs. @@ -296,15 +241,13 @@ Alternately, you can use a different container tool that offers Docker compatibl - [OrbStack](https://orbstack.dev/) (macOS) - [colima](https://github.com/abiosoft/colima) (macOS) - - Inside the folder where you want to create your project, run: ```bash supabase init ``` -This will create a new `supabase` folder. It's safe to commit this folder to your version control system. +This creates a new `supabase` folder. It's safe to commit this folder to version control. Now, to start the Supabase stack, run: @@ -312,11 +255,11 @@ Now, to start the Supabase stack, run: supabase start ``` -This takes time on your first run because the CLI needs to download the Docker images to your local machine. The CLI includes the entire Supabase toolset, and a few additional images that are useful for local development (like a local SMTP server and a database diff tool). +This takes time on your first run because the CLI needs to download the Docker images to your local machine. The CLI includes the entire Supabase stack, and a few additional images useful for local development (like a local SMTP server and a database diff tool). ## Access your project's services -Once all of the Supabase services are running, you'll see output containing your local Supabase credentials. It should look like this, with urls and keys that you'll use in your local project: +Once all the Supabase services are running, you'll see output containing your local Supabase credentials. It should look like the below, with urls and keys that you use in your local project: ``` Started supabase local development setup. @@ -427,7 +370,7 @@ For advanced logs analysis using the Logs Explorer, it is advised to use the Big -All logs will be stored in the local database under the `_analytics` schema. +All logs are stored in the local database under the `_analytics` schema. diff --git a/apps/docs/public/img/guides/cli/docker-mac-light.png b/apps/docs/public/img/guides/cli/docker-mac-light.png deleted file mode 100644 index ca0c3f88543..00000000000 Binary files a/apps/docs/public/img/guides/cli/docker-mac-light.png and /dev/null differ diff --git a/apps/docs/public/img/guides/cli/docker-mac.png b/apps/docs/public/img/guides/cli/docker-mac.png deleted file mode 100644 index 733eada80a1..00000000000 Binary files a/apps/docs/public/img/guides/cli/docker-mac.png and /dev/null differ diff --git a/apps/docs/public/img/guides/cli/docker-win-light.png b/apps/docs/public/img/guides/cli/docker-win-light.png deleted file mode 100644 index 13778f64577..00000000000 Binary files a/apps/docs/public/img/guides/cli/docker-win-light.png and /dev/null differ diff --git a/apps/docs/public/img/guides/cli/docker-win.png b/apps/docs/public/img/guides/cli/docker-win.png deleted file mode 100644 index 9a2b389deb3..00000000000 Binary files a/apps/docs/public/img/guides/cli/docker-win.png and /dev/null differ