Creek Studio CLI

A command line tool for Creek Studio.

• You can use it to start a development environment.

• Eventually, it will also deploy a production environment — once Creek Studio is ready for people to host it themselves.

Quick Start

With NPX

1. Make sure that you have Node.js and Docker installed.

2. Run this command:

   npx @creek/studio-cli create-dev

3. Inspect the .env file.

   cd studio/studio-cli
   cat .env

   • The .env includes the initial user's email and password, among other settings.

   • This .env file will get copied to the studio-server project when you run the next command below (./creek start-dev).

     • Do not edit the .env file in the studio-server project directly.

4. Start the development environment:

   ./creek start-dev

Options:

• --domain (default: localhost)

  • If you want to use a different domain name, you can pass it in like this:

    npx @creek/create-studio-dev --domain "mydomain.com"

• --path (default: ./studio)

  • The path to create the development environment in.

    npx @creek/create-studio-dev --path "/path/to/creek/studio"

./creek CLI

In addition to the NPX command above, you can directly use the ./creek script in this studio-cli project to run other commands.

Create a new development environment with ./creek

Create a new development environment like this:

1. Make sure that you have Docker installed.

2. Clone this repository:

   git clone [email protected]:studio/studio-cli.git

3. Create a new project for development:

   cd studio-cli
   ./creek create-dev --domain "localhost"

   • This will clone the studio-interface and studio-server repositories into the same parent directory as this studio-cli repository.

   • It will also rebuild the .env file in this folder, including updating the domain name to localhost (or whatever you passed in as the --domain argument).

4. Inspect the ./.env file in this studio-cli directory.

   • Includes the initial user's email and password, among other settings.

   • This .env file will get copied to the studio-server project when you run the next command below (./creek start-dev).

     • Do not edit the .env file in the studio-server project directly.

5. Start the Creek Studio development environment:

   ./creek start-dev

Commands

Create Dev

This command will create a new project for development.

./creek create-dev --domain "localhost"

Start Dev

This command will start the project in development mode.

./creek start-dev

Start Dev in Background

This command will start the project in development mode, but in the background.

./creek start-dev-in-background

Logs

This command will show the logs for the project.

./creek logs all

Destroy

This command will destroy the project and all of its data, so that you can rebuild it from scratch.

./creek destroy