Skip to content

Commands

johannes kanthak edited this page Apr 19, 2024 · 1 revision

Terminal Commands

Commands Introduction

Jetline includes a variety of commands for maintaining and operating your project.

Command: jetline

The jetline command displays information about your project.

jetline

Command: jetline-setup

The jetline-setup command is used to create a new project. You can optionally specify the project name and pipeline folder name.

jetline-setup

Command: jetline-create-pipe

The jetline-create-pipe command allows you to create a new pipeline in your project. You can specify the name of the new pipeline using the --pipeline-name argument.

jetline-create-pipe

Command: jetline-analyze

The jetline-analyze command is useful for conducting an analysis of your project. It creates a JSON file which contains crucial information about the pipelines and nodes. It might check for things such as static code issues or performance problems.

The generated JSON file is especially useful for visualizing the pipelines.

jetline-analyze

Command: jetline-run

The jetline-run command facilitates the execution of your pipelines. The [args] are optional and can be used to run individual pipelines.

For example, to run a pipeline named 'example_pipe', you would use the command: If you need to run multiple pipelines, you can separate them with a comma. For instance, to run 'example_pipe' and 'example_pipe2', the command would be:

jetline-run

Command: jetline-to-exe

The jetline-to-exe command is intended to transform your project into one .py-file, that you can easily compile into an exe.

jetline-to-exe
jetline-to-exe example_pipe,example_pipe2

Notes and Tips

Don't forget to replace the placeholders like [project_name], [pipeline_name], [pipeline_name] and [args] with your actual values while using the commands. For further usage information on any individual command, you can always use the help flag -h or --help following any command to get more details.