CLI Usage

CLI Installation and Setup

The CLI (Command Line Interface) provides a powerful way to interact with the software beyond the graphical user interface. To use the CLI, you need to install it first. This is usually done via package managers specific to your operating system.

Installation on Linux

Package Manager: Use your preferred Linux package manager.

# Example using apt for Debian-based distributions
sudo apt-get update 
sudo apt-get install software-cli

Verify Installation: Check that the CLI is installed by running the following command in your terminal.
```
software-cli --version
```
This should output the CLI version if it's installed correctly.

Installation on macOS

Homebrew: If you're using Homebrew, install the CLI with:
```
brew install software-cli
```
Verify Installation: Similar to Linux, run the following command:
```
software-cli --version
```
This should output the CLI version if it's installed correctly.

Installation on Windows

Download: Download the appropriate installer from the software's official website. Refer to the Installation Guide for the latest downloads.
Run Installer: Run the downloaded installer and follow the on-screen instructions.
Add to PATH: Once installed, you might need to add the CLI's installation directory to your system's PATH environment variable for convenient access from anywhere on your computer. See the Installation Guide for detailed instructions.

Common Commands

The CLI offers a range of commands to manage and interact with the software. Here are some commonly used commands:

Project Management

software-cli project list: Lists all available projects within your workspace.
software-cli project create <project-name>: Creates a new project with the specified name.
software-cli project open <project-name>: Opens an existing project.
software-cli project delete <project-name>: Deletes a project.

Data Operations

software-cli data import <data-file>: Imports data from a specified file.
software-cli data export <output-file>: Exports data to a file.
software-cli data query <query-expression>: Executes a query on the data.

Pipeline Management

software-cli pipeline list: Lists all available pipelines in the current project.
software-cli pipeline create <pipeline-name>: Creates a new pipeline.
software-cli pipeline run <pipeline-name>: Runs a specific pipeline.
software-cli pipeline stop <pipeline-name>: Stops a running pipeline.
software-cli pipeline logs <pipeline-name>: Displays logs for a pipeline.

System Information

software-cli version: Displays the current version of the CLI.
software-cli system info: Shows information about the system, such as hardware and software specifications.

Scripting and Automation

The CLI commands can be combined into scripts for automating tasks and streamlining workflows. Here are some examples:

Creating a Project and Importing Data

#!/bin/bash

# Create a new project called "MyProject"
software-cli project create MyProject

# Open the project
software-cli project open MyProject

# Import data from a file
software-cli data import data.csv

# Run a specific pipeline
software-cli pipeline run "Data Processing"

Batch Data Export

#!/bin/bash

# Loop through a list of projects
for project in project1 project2 project3; do

    # Open the project
    software-cli project open $project

    # Export data to a file
    software-cli data export $project-data.csv

    # Close the project
    software-cli project close
done

These are just basic examples; the possibilities for scripting are vast. You can leverage the CLI's features to automate complex tasks, streamline repetitive operations, and integrate with other tools within your development environment.

For more advanced CLI usage, you can refer to the Reference section, which contains a detailed list of all commands and their options. You can also find additional examples and best practices for CLI scripting in the Developer Guide.

Example Wiki