Skip to content
AI4SAIPublic

About

Local Slurm/Lustre queries for people; structured SAI operations for scripts and agents.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SAI CLI

Fast cluster queries for people. Structured SAI operations for scripts and Agents.

Use familiar SSH commands on a cluster, or connect your own computer and Agent through normal SAI authorization. The client contains no model loop and does not require Pilot.

On a cluster

sqm                 # your jobs
sqa                 # the applied computing account and its child projects
gpu                 # GPU allocation and available nodes
cpu                 # CPU and memory allocation
quota               # quota for the current directory
sai tui             # select jobs/nodes with arrows or a click; q exits

These queries run locally under your Unix identity. In the TUI, p pauses or resumes updates, Enter inspects a row, and c requests that job's running cost through your authorized SAI account. Allocation is distinct from utilization; running estimates are distinct from settled charges.

The job selector discovers your native Slurm accounts; quota lets you choose an actual directory. Job details lead with the allocation and a compact CPU/NUMA and GPU connection view when a current hardware record is available. i expands hardware details; arrow/page keys scroll, r refreshes, and Escape returns to the selected row. Native account names are also available as JSON through sai account local. These reads do not change your shell or defaults.

Native adapters have been exercised with Slurm 26.05.1 and Lustre 2.17; other native versions are not yet qualified. Pending-job details can include the account limit and service level recorded by the site writer. The record time is shown separately from the current job state. This optional context follows native visibility and does not require Portal login.

On your computer

Python 3.11+ is required. Existing portable-client qualification covers Linux; macOS and Windows are not yet qualified. The examples below target 0.2.0a3. Published wheels and SHA-256 checksums are available from the versioned releases. With your reviewed wheel and matching checksum, verify it and install with pipx:

pipx install ./sai_cli-0.2.0a3-py3-none-any.whl
sai configure https://console.example.org --format table
sai auth login
sai sites --format table

Use your service's trusted URL in place of the example. Confirm the login code in your browser, then choose a returned site explicitly:

sai resources catalog --site site-a --format table
sai account defaults --site site-a --format table

The catalogue contains published specifications and prices. Account defaults shows your authorized choices; neither command changes an account or grants site access. Configuration preserves existing profiles and credentials. See first use and recovery for wheel installation, additional permissions, multiple services and upgrade/rollback.

The base client has no third-party runtime dependency. To add the optional interface, including to an existing base installation, use pipx install --force './sai_cli-0.2.0a3-py3-none-any.whl[tui]'. This preserves your user configuration and credentials. It needs an interactive terminal. Local views require the corresponding Slurm/Lustre tools on that host. Use the wheel filename for your reviewed version. The a1 and a2 releases and their assets remain unchanged; see the a3 scope.

With your Agent

sai describe
sai describe account set-default
sai skill --format markdown

describe is the installed command authority. skill exports matching Agent instructions for the host you choose; neither requires login or network access. Commands return JSON by default, with separate structured errors and documented exit codes. A task can request its missing permissions with auth login --for, followed by the user's browser confirmation.

The client supports native queue/resource/quota reads, account and cost queries, job allocation and recorded-run outputs, default-account changes and recipient invitation acceptance. Version a3 includes projects enable-compute, invitation v2 and task-specific consent/resume with the existing paired backend and optional grants. The called service owns authorization and reports whether a change was accepted or applied. Broader project, storage and compute lifecycle management remains planned. invitations accept ID previews file and computation permissions and the payer; add --apply to accept. This v2 workflow requires the paired Portal update.

Learn more

First-party client code, the shared native projection and bundled Agent guidance are licensed under Apache-2.0. Historical Slurm patch prototypes retain their upstream GPL terms in the repository archive and are excluded from Python distributions. Site integration targets unmodified upstream Slurm. The standard association Comment migration and its paired deployment checks are tracked in the roadmap. The repository's site integration artifacts have their own deployment roles; installing the Python client never installs or changes a scheduler, login profile or storage service.

The interconnect contract joins recorded CPU/NUMA, PCIe, GPU and fabric relationships to an exact live allocation via --with-interconnect. Local reads stay native; the existing site gateway uses include_interconnect=true. Deployment and its validation boundary are recorded in terminal scope.

About

Local Slurm/Lustre queries for people; structured SAI operations for scripts and agents.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages