Skip to content

Create a project

Initialize Project

Once you have created an account and setup the CLI tool, the easiest way to start a project is to request a Project Config template from PIPES.

$ pipes project template -t project-creation -o my-project.toml

This outputs a TOML file called my-project.toml. The example configuration includes setup for:

  • Project
  • Project Runs
  • Models
  • Handoffs
  • Modeling Teams

Create Project

  1. Once you have the TOML example, you can edit and rename the file.

    • For more descriptions on what information goes into a project, please see the Project Reference.

    • For more information on the project schema, please see the Project Config.

  2. Run the command below to create the project in PIPES.

$ pipes project create -f sample-project.toml

After run the command, you will see the messages output on terminal console about the project creation.

Warning

The project name in PIPES must be unique. If you attempt to create a project with a name that already exists, an error will be raised. You'll need to rename the project and try again.

After project created, you can run CLI commands the pull the project information or go to view on the Web page.