Skip to main content

Bootstrap machines and run cached utility scripts from one CLI.

Project description

usm

Release PyPI Release workflow Python

usm is a lightweight CLI for machine bootstrap tasks and day-to-day utility scripts. It gives you one command for common setup jobs, Azure/blobfuse workflows, and a few personal productivity helpers, while keeping the underlying scripts easy to iterate on.

The package installs as usmo, but the executable command is usm.

Highlights

  • One entrypoint for machine setup, storage helpers, and quick admin tasks.
  • On-demand script download and caching under ~/.cache/usm/scripts.
  • Python subcommands run with the package interpreter, which keeps pipx installs isolated and reliable.
  • Local --debug mode for iterating on scripts in this repository without downloading from GitHub.
  • Simple release flow driven by Git tags.

Installation

Quick Install (recommended)

curl -fsSL https://raw.githubusercontent.com/HSPK/usm/main/scripts/install.sh | bash

The script will automatically install pipx if needed, then install usmo via pipx. You may need to run source ~/.bashrc (or restart your shell) afterwards for the usm command to become available.

Manual Install

Install from PyPI with pipx:

pipx install usmo

PyPI package page: https://pypi.org/project/usmo/

Or install from a local checkout while developing:

uv sync
pipx install --force .

After installation, the CLI is available as:

usm <command> [args...]

Commands

Scripts

Scripts are defined in scripts/_config.json and downloaded on first use. Add new commands by editing that file — no Python changes required.

Command Description
usm init Bootstrap a fresh Ubuntu machine with common packages, shell aliases, pipx tools, tmux plugins, and Neovim config.
usm blobmount <mount_dir> <account> <container> Install blobfuse2 if needed, generate a SAS token from your Azure CLI login, and mount a blob container locally.
usm cu122 Install NVIDIA driver 535, CUDA 12.2, and Vulkan-related packages on Ubuntu.
usm cp [--use-sas-token] <source>... <destination> Copy between local paths and blobfuse2 mountpoints, delegating to azcopy when Azure storage is involved.
usm check_py Print the active Python and pip locations and versions.
usm sysinfo Print system, GPU, CUDA, MPI, and distributed-ML environment summary.
usm inject-alias [--shell bash|zsh|powershell] [--file PATH] Insert or update the managed usm alias block in your shell rc file. Defaults to ~/.bashrc on Unix-like systems and the PowerShell profile on Windows, with interactive shell selection when run in a TTY. You can combine --shell with --file to control the syntax written to a custom path.

Built-in helpers

Command Description
usm list List all available commands and their cache status.
usm update Re-download the config and all cached scripts.
usm clean Remove the script cache directory (~/.cache/usm/scripts).
usm version Show the installed usm version.

Examples

Initialize a new machine:

usm init

Mount a blob container:

usm blobmount /mnt/data myaccount mycontainer

Copy from a blobfuse mount to a local directory:

usm cp /mnt/data/project ./project-backup

Refresh the cached script before running it:

usm --upgrade check_py

Run against the local scripts/ directory instead of downloading from GitHub:

usm --debug check_py

Inject aliases into your zsh profile:

usm inject-alias --shell zsh

Inject aliases into your PowerShell profile:

usm inject-alias --shell powershell

Write the managed alias block into a specific file:

usm inject-alias --file ~/.config/usm/test-shell.rc

Write PowerShell-flavored aliases into a custom profile file:

usm inject-alias --shell powershell --file ~/Documents/PowerShell/Microsoft.PowerShell_profile.ps1

How it Works

The CLI keeps a small manifest of commands in src/usmo/cli.py.

  • Shell scripts are executed with bash.
  • Python scripts are executed with the current interpreter via sys.executable.
  • Remote scripts are downloaded from this repository and cached locally.
  • --upgrade forces a fresh download of the selected script.
  • --debug bypasses the cache and runs the local file under scripts/.
  • Managed alias insertion uses start/end markers so rerunning the command updates the block instead of duplicating it.
  • inject-alias is implemented with click and supports bash, zsh, and PowerShell profile targets.

Development

Install the project locally:

uv sync

Build distributable artifacts:

uv build

Smoke-test the installed command:

uv run usm check_py

Release Flow

This repository includes a GitHub Actions workflow at .github/workflows/release.yml.

When you push a tag like v0.1.8, GitHub Actions will:

  1. Verify the tag matches the version in pyproject.toml.
  2. Build the source distribution and wheel with uv build.
  3. Create or update a GitHub Release for that tag.
  4. Upload the built artifacts to the release page.
  5. Publish to PyPI via Trusted Publishing (no secrets needed).

Create a new release with:

git tag -a v0.1.8 -m "v0.1.8"
git push origin v0.1.8

Notes

  • Some scripts are tailored for Ubuntu-based environments.
  • blobmount and cp expect Azure CLI / azcopy / blobfuse2 style workflows.
  • Cached scripts live in ~/.cache/usm/scripts.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

usmo-0.1.8.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

usmo-0.1.8-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file usmo-0.1.8.tar.gz.

File metadata

  • Download URL: usmo-0.1.8.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for usmo-0.1.8.tar.gz
Algorithm Hash digest
SHA256 9515c3af1cc825b35989170935fab6e6f6afd7638e6e69b326a2bc89506be358
MD5 95658c58990e3a55e5a26e551fc786ac
BLAKE2b-256 8f202d85b92a5ab3c379690840fe4d91b362e290d4aae6381a927c9c80905888

See more details on using hashes here.

Provenance

The following attestation bundles were made for usmo-0.1.8.tar.gz:

Publisher: release.yml on HSPK/usm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file usmo-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: usmo-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for usmo-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3b5f433902df1bc2b517301ff9be9b6fd65980bc4d9c4d8bb466a09908177ff9
MD5 4dba3bf2c752f4c5dc99393eaf2b46d9
BLAKE2b-256 aabb15479b0750bde74414cda065f35129de16f46f2eda6e00a03666f8b3b892

See more details on using hashes here.

Provenance

The following attestation bundles were made for usmo-0.1.8-py3-none-any.whl:

Publisher: release.yml on HSPK/usm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page