Skip to content

Commands

Currently, the CLI is the primary client interface for technical users to interact with PIPES. For example, by using CLI, we can initialize the project, create model run, retrieve model information, checkin dataset, etc. In the following section, we’ll introduce pipes commands, and see how to use the them to build project pipelines in PIPES to assist the project management and collaboration in use cases.

Check the CLI client with pipes --help , which would show the following group commands,

$ pipes --help
Usage: pipes [OPTIONS] COMMAND [ARGS]...

  PIPES CLI client

Options:
  --help  Show this message and exit.

Commands:
  config      Config the PIPES client
  dataset     Dataset operation commands
  login       Login to PIPES API server
  model       Model operation commands
  modelrun    Model run operation commands
  project     Project operation commands
  projectrun  Project run operation commands
  server      Server operation commands
  task        User operation commands
  team        Project operation commands
  user        User operation commands

The following sections provide a quick overview of using the pipes sub-commands to perform PIPES operations.

Client Commands

Project

Create a new project?

A quick review on steps,

  • Get project initialization TOML template.
  • Fill your template based on instruction. *Create the project by using your project template.

The according commands are showing below,

# step 1
$ pipes project template -t project-creation -o my-pipes-project.toml

# step 2
Edit and provide my-pipes-project.toml TOML template in text editor

# step 3
$ pipes project create -f my-pipes-project.toml

List all your projects?

To get all your available projects, run the following command:

$ pipes project list

Get an existing project?

To get the existing project information from PIPES, use the command below.

$ pipes project get -p <project-name>

Get a project owner info?

To get the project owner information, use this --owner flag,

$ pipes project get -p <project-name> --owner

Project Run

List all project runs under given project?

List all project runs under given project,

$ pipes projectrun list -p <project-name>

Model

List all models under given project and project run,

$ pipes model list -p <project-name> -r <project-run-name>

Model Run

List all model runs under given project, project run, and/or model.

$ pipes modelrun list -p <project-name> -r <project-run-name> -m <model-name>

Dataset

List all datasets under given context (project, project run, model, model run)

$ pipes dataset list -p <project-name> -r <project-run-name> -m <model-name> -x <model-run-name>

Task

List all tasks under given context,

$ pipes task list -p <project-name> -r <project-run-name> -m <model-name> -x <model-run-name>

Handoff

List all handoffs under given context,

$ pipes handoff list -p <project-name> -r <project-run-name> -m <model-name>

Team

List all modeling teams under given project,

$ pipes team list -p <project-name>

Get one team info with given project and team name,

$ pipes team get -p <project-name> -t <team-name>

Create a new team under given project,

$ pipes team template -t team-creation -o my-new-team.toml

# Then edit the template with required team information

$ pipes team create -p <project-name> -f my-new-team.toml

User

List all users under PIPES (Admin only)

$ pipes user list

Get user info by username (email) 

$ pipes user get -u <email>

Create a new user

$ pipes user create -u <email> -f <first-name> -l <last-name> -o <orgnization>

Technical Support

The CLI client is still under development, more commands will be available soon! If any issue or questions about the commands, please feel free to reach out to the PIPES team!