☀️ solx

📋 Cheat sheet  ·  📖 solx docs  ·  🌵 Sol skill

_{cheat sheet also as a PDF or from the CLI: solx cheatsheet}

Solx is a CLI for ASU's Sol supercomputer, designed for agent-assisted work so you can stop babysitting Slurm.

• No memorizing SLURM commands.
• No surprise /scratch purges.
• Let your agent manage your SLURM jobs.

SSH to Sol, run solx, and keep the whole loop in your terminal.

Installation

solx is a single static binary — no Python, no uv, no toolchain on the box. On Sol, download it, make it executable, and put it on your $PATH:

mkdir -p ~/.local/bin
curl -fLo ~/.local/bin/solx https://github.com/Shu-Wan/solx/releases/latest/download/solx-x86_64-unknown-linux-musl
chmod +x ~/.local/bin/solx

Re-run those two lines to upgrade. The binary is fully static (musl), so it runs on any x86-64 Linux — Sol's RHEL 8 included.

Usage

solx init                 # one-time: write ~/.config/solx/config.toml
solx config edit          # define your job templates + [keep] paths
solx job start gpu        # request an interactive allocation (waits for the grant)
solx job jump             # open a shell on the compute node
solx keep                 # renew /scratch files Sol has flagged for deletion

What it's good at:

• Interactive jobs from templates. Define [jobs.gpu] once, then solx job start gpu allocates and waits and solx job jump drops you onto the node. Cancel with solx job stop (or raw scancel).
• Keeping /scratch alive. Sol purges inactive files on a schedule; solx keep renews only the directories you listed in [keep] that Sol has actually flagged — never a blanket touch. → walkthrough: docs/scratch.md
• Built for CLI agents. Output auto-switches to JSON off a TTY, exit codes are meaningful, and destructive commands refuse rather than hang on a prompt.

Learn more: the full command manual is docs/solx.md. Cached reference notes on Sol conventions — the solx CLI, the Sol cheat sheet (PDF), modules, scratch policy, Slurm jobs, ssh tunnels, file sharing — live with the skill.

🌵 The companion skill

skills/sol-skill/ teaches an AI coding assistant to operate on Sol the careful way. It turns natural requests like "start a GPU session," "why is my job pending?", or "keep my scratch project alive" into the right solx or raw Slurm command, while also handling environment detection, partition choice, fairshare and wall-time awareness, modules, data movement, and Sol-side services.

gh skill install Shu-Wan/solx sol-skill

Any Agent Skills installer works the same way.

Development

• Changelog — CHANGELOG.md; the current release is shown by the Release badge at the top of this README.
• Roadmap — docs/ROADMAP.md.
• Contributing, tests, and the eval harness — DEVELOPMENT.md and solx/DEVELOPMENT.md, with the coverage matrix in docs/coverage.md.

Disclaimer

A personal toolkit — not affiliated with or endorsed by ASU Research Computing. The official documentation at https://docs.rc.asu.edu/ is authoritative on every Sol policy referenced here. solx keep changes file timestamps under /scratch (it never reads, moves, or deletes content); the job commands submit and cancel Slurm jobs. Preview with --dry-run, review what an agent proposes before approving it, and verify against the official docs. Provided as-is, with no warranty. MIT licensed — see LICENSE.