CLI Reference
  • Dark
    Light
  • PDF

CLI Reference

  • Dark
    Light
  • PDF

The Dataloop CLI is an SDK tool allowing you to easily browse and perform actions locally on the platform.

Dataloop's CLI

The Dataloop CLI is performed on a Command-Line Interface "CLI" using the Dataloop Python dtlpy package, which enables a Python connection to Dataloop's environment.
This tool is one of the many Python SDK tools we offer to help you customize your experience with Dataloop.

Common use cases

  • Local login
  • Upload & Download files
  • Manage packages, functions, and pipelines
    To learn more about the command-line shell, click here.

Install & Login

Install Using pip

Install the plugin using pip , write the following command and click "enter":

Please be sure that you have pip installed on your computer. If not please download pip You can check if you have pip installed on your computer, by using: pip help. If PIP responds, then PIP is installed. Otherwise, there will be an error message saying the program could not be found.
pip install dtlpy

Alternatively, install it from the source by cloning the GitHub repo run:

python setup.py install

Explore advanced options on this page.

Login

dlp login

Update

pip install dtlpy --upgrade

Refer to the following page to see the dtlpy latest version and version history.

Explore our release notes to see the changes for each version.

Logout

dlp logout

 Validate install 

C:\Users\admin>dlp login
2020-01-07 13:52:36.146 [ERROR]- dtlpy: Token expired. Please login
2020-01-07 13:52:36.148 [WARNING]- dtlpy.services.cookie: Key not in platform cookie file: check_version_status. Return None
2020-01-07 11:52:36.218935
2020-01-07 13:52:36.223 [INFO]- dtlpy.services.api_client: Logging in to Dataloop...
2020-01-07 13:52:51.318 [INFO]- dtlpy.services.api_client: Logged in: eran@dataloop.ai
See "dlp --help" for options

 Help


At any given point you may use the "--help" flag in dlp CLI. This provides all of the available options at your current position on the shell.
For example, seeing your options for dlp - projects.

dlp projects --help # The command line


 Output

C:\Users\admin>dlp projects --help #The command line
usage: dlp projects [-h] {ls,create,checkout,web} ...

positional arguments:
  {ls,create,checkout,web}
                        projects operations
    ls                  List all projects #The "Is" command lists all of the projects
    create              Create a new project #The "create" command creates a new project
    checkout            checkout a project #The "checkout" command checkouts a project
    web                 Open in web browser #The "web" command opens the project in the browser

optional arguments:
  -h, --help            show this help message and exit

What's Next