CLI Reference¶

This page provides documentation for the ezbrew command line interface.

ezbrew¶

This is the entrypoint into the ezbrew CLI

All commands are part of this entrypoint, like create, start, init, parse, etc.

Usage:

ezbrew [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew create¶

create command is a top-level ezbrew command that is used to create units of ezbrew like projects, pipelines, tasks, etc.

Usage:

ezbrew create [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew create pipeline¶

This command can be used to create a new ezbrew pipeline.

On running this command, a new pipeline folder is created within the specified git-enabled project folder.

This also creates the DAG definition file that includes the name of the pipeline and other specific DAG related runtime parameters.

Usage:

ezbrew create pipeline [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	Enter the name of the project where the pipeline will be created	None
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew create project¶

This command can be used to create a new ezbrew project.

On running this command, a git-enabled project folder with the specified project name is created.

Usage:

ezbrew create project [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	Enter the name of the project to be created	None
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew create task¶

This command can be used to create a new ezbrew task.

On running this command, a new task YAML file is created under the tasks folder of the specified pipeline within the git-enabled project folder.

All task specific options will need to be added into this file.

Tasks can be of different types like ingest, transform, check, etc.

TODO: Add more details as we generalize the tasks

Usage:

ezbrew create task [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	Enter the name of the project in which the task will be created	None
`--pipeline_name`	text	Enter the name of the pipeline in which the task will be created	None
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew init¶

init is a top level command that is used to initialize a unit of ezbrew like an environment

Usage:

ezbrew init [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew init env¶

The init command helps initialize all the required project environment resources.

This is where the project template folder is used to create the project folder structure.

TODO: Environment configurations as part of this step, linking the environment to the project.

Usage:

ezbrew init env [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	Enter the name of the project where the environment is created	None
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew parse¶

parse is a top level command used to generate the tool-specific code

Usage:

ezbrew parse [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew parse pipeline¶

This command helps generate the pipeline code as per the selected orchestration tool of the environment.

The output of this command can be used to deploy to the orchestration tool to run the pipeline.

Usage:

ezbrew parse pipeline [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	Enter the name of the project	None
`--pipeline_name`	text	Enter the name of the pipeline to be parsed	None
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew publish¶

publish

Usage:

ezbrew publish [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

ezbrew publish project¶

publish a project

Usage:

ezbrew publish project [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	N/A	None
`--help`	boolean	Show this message and exit.	`False`

ezbrew start¶

start is a top level command used to start a unit of ezbrew like an environment or a pipeline

Usage:

ezbrew start [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show usage details for the command and exit	`False`

ezbrew start env¶

This command is used to set up the local development environment.

The required tools for ingest, transform, quality, visualize and orchestrate are installed within a local kubernetes cluster.

Usage:

ezbrew start env [OPTIONS]

Options:

Name	Type	Description	Default
`--project_name`	text	Enter the name of the project that the environment will be linked to	None
`--help`	boolean	Show usage details for the command and exit	`False`