Installing the Begin CLI

You interact with Begin Deploy using the Begin CLI. Installing the Begin CLI should only take 1-2 minutes.

Prerequisites

  • Any computer running macOS, Windows, or Linux, with Node.js 14, or later
  • If deploying to Begin: a (free) GitHub account to authenticate the Begin CLI

Install

In your terminal run the following the command:

curl -sS https://dl.begin.com/install.sh | sh
iwr https://dl.begin.com/install.ps1 -useb | iex

Then follow the printed instructions to add the Begin CLI to your $PATH.

Quick runthrough

Let’s try out some of the core aspects of the Begin CLI by creating and deploying a sample app.

Create a new Enhance app

For this example, we’ll create and deploy a new Enhance app:

npx "@enhance/cli@latest" new ./myproject -y

Preview your app

Start the local server for the Enhance app like so:

cd myproject
npm start

You’ll find the app running locally at localhost:3333.

Log in

Create a Begin account by running the following command in your terminal, then following the instructions to authorize with GitHub.

begin login
b login

Deploy

Time to ship your brand new project to a fresh environment!

begin deploy
b app deploy

Congratulations, that’s just about it!

Now, let’s go check out a simple GitHub Actions Begin setup.