1. Home
  2. CLI

CLI

Keboola CLI (Command Line Interface), known also as “Keboola as Code”, is a set of commands for operating your cloud data pipeline. It is available to install in the Windows, macOS, and Linux environments.

The whole Keboola project is represented by a local directory structure. Component configurations are represented by JSON files.

Use Cases

Keboola CLI can be used, for example, to:

  • Pull your entire project to a local directory in seconds. See the init and pull commands.
  • Bulk edit component configurations in your IDE.
  • Compare the local version with the current project state. See the diff command.
  • Copy a configuration as a directory in the project and between projects. See the persist command.
  • Apply all changes back to the project in a moment. See the push command.
  • Manage project history in a git repository.
  • Automate the whole process in a CI/CD pipeline. See GitHub Integration.

Subsystems

Brief overview of supported subsystems of the project.

Configurations

Development Branches

  • A branch can be pulled and then edited or deleted locally.
  • Changes can be pushed back to the project.
  • There is one limitation, a branch cannot be created locally.
    • A branch must be created directly in the project, from the main branch.
    • See the Create Branch command.

Storage

  • Storage is NOT supported at this time.
  • It is not possible to work with table definitions or contents.
  • We plan to add storage support in the future.

Next Steps