Skip to main content

​
Using the Octopipe CLI Tutorial

This tutorial is designed to help you become proficient with the Octopipe Command-Line Interface (CLI). You’ll learn about the various commands available and how to use them effectively to manage your pipelines.

​
Introduction

Octopipe’s CLI offers a rich set of commands to initialize projects, manage data sources and destinations, define transformations, and orchestrate pipelines. In this guide, we will cover:
  • Basic CLI navigation
  • Essential commands and their usage
  • Tips and best practices for effective CLI usage

​
Getting Started with the CLI

​
Verifying Installation

After installing Octopipe, check that the CLI is working by running:
• Expected Output: The current version of Octopipe will be displayed. Accessing Help For general help, use:
For command-specific help, append the command name. For example:
Core Commands Overview Initialization Initialize a new project with:
Authentication Log in to access Octopipe’s features:
Log out when finished:
Managing Data Sources and Destinations Add a data source:
Add a data destination:
Transformation and Pipeline Commands Define a transformation:
Create a pipeline:
Start the pipeline:
Monitor logs:
Advanced CLI Usage • Verbose Mode: Add —verbose to commands for detailed output. For example:
• Custom Configuration Files: Use the —config-file flag to load custom settings:
• Chaining Commands: Combine commands in scripts to automate tasks like initialization and deployment. Best Practices • Keep Commands Modular: Test each command individually to verify connectivity and correct configuration. • Use Descriptive Names: This helps maintain clarity when managing multiple pipelines. • Regularly Update the CLI: Stay current with the latest features and bug fixes. Troubleshooting CLI Issues • Command Not Found: Verify your PATH environment variable includes the Octopipe binary. • Authentication Errors: Double-check your API key or username/password if login fails. • Verbose Logging: Use the —verbose flag to get more detailed error messages. Conclusion Mastering the Octopipe CLI is key to efficiently managing your data pipelines. This tutorial provided an overview of essential commands and best practices. Experiment with these commands and refer to our detailed reference documents for more advanced usage. Happy CLI-ing!