Skip to content

README.md

Latest commit

 

History

History
190 lines (150 loc) · 3.93 KB

README.md

File metadata and controls

190 lines (150 loc) · 3.93 KB

Xether AI CLI

The official Command-Line Interface for the Xether AI platform. It allows developers and data engineers to manage datasets, orchestrate pipelines, and retrieve artifacts directly from their terminal.

Installation

Prerequisites

  • Python 3.9 or higher
  • Poetry (Recommended)

Local Setup

  1. Navigate to the CLI directory:
cd "Xether AI/CLI"
  1. Install dependencies using Poetry:
poetry install
  1. (Optional) Enter the poetry shell to use xether directly:
poetry shell

Alternatively, you can run commands using poetry run xether ...

Configuration & Authentication

Before using the CLI, you must log in:

xether auth login

This prompts for your Xether AI email and password. A session token is saved locally to ~/.xether/config.json.

To set your backend endpoint (useful for local development vs production):

xether config set --backend-url http://localhost:8000
xether config view

To log out and clear your session:

xether auth logout

Core Commands

Teams

Manage team organization and membership.

  • List teams: 
    xether team ls
  • View team details: 
    xether team info <TEAM_ID>
  • Create a new team: 
    xether team create --name "My Team" --description "Team description"
  • Update team details: 
    xether team update <TEAM_ID> --name "New Name" --description "New description"
  • List team members: 
    xether team members <TEAM_ID>
  • Add a team member: 
    xether team add-member <TEAM_ID> --user <USER_ID> --role developer
  • Remove a team member: 
    xether team remove-member <TEAM_ID> --user <USER_ID>
  • Delete a team: 
    xether team delete <TEAM_ID> --confirm

Projects

Manage project workspaces and team collaboration.

  • List projects: 
    xether project ls
  • List projects in a specific team: 
    xether project ls --team <TEAM_ID>
  • View project details: 
    xether project info <PROJECT_ID>
  • Create a new project: 
    xether project create --name "My Project" --team <TEAM_ID> --description "Project description"
  • Update project details: 
    xether project update <PROJECT_ID> --name "New Name" --description "New description"
  • Delete a project: 
    xether project delete <PROJECT_ID> --confirm

Datasets

Manage your raw data and files in the Xether Dataset Registry.

  • List datasets: 
    xether dataset ls
  • View dataset details: 
    xether dataset info <DATASET_ID>
  • Upload a new dataset: 
    xether dataset push /path/to/my_data.csv --name my-cleaned-data
  • Delete a dataset: 
    xether dataset rm <DATASET_ID>

Pipelines

Trigger data transformations and monitor their execution.

  • List available pipelines: 
    xether pipeline ls
  • Run a pipeline against a specific dataset: 
    xether pipeline run <PIPELINE_ID> --dataset <DATASET_ID>
    (Returns an Execution ID)
  • Check the real-time status of an execution: 
    xether pipeline status <EXECUTION_ID>
  • View execution history for a pipeline: 
    xether pipeline history <PIPELINE_ID>

Artifacts

Retrieve the final outputs (models, cleaned datasets, reports) generated by your pipelines.

  • List available artifacts: 
    xether artifact ls
    (Optionally filter by execution ID: xether artifact ls -e <EXECUTION_ID>)
  • Download an artifact: 
    xether artifact download <ARTIFACT_ID> /local/destination/path

Development

The CLI is built with Typer, Rich, and HTTPX.

Running Tests

poetry run pytest tests/