Python REST API client for Shaken Fist

This is a python REST API client and command line client for the minimal cloud Shaken Fist.

The library is a complete interface to the Shaken Fist HTTP API.

Installation

pip install shakenfist-client

Add the vdi extra if you want graphical instance consoles to open seamlessly through the Kerbside SPICE proxy:

pip install shakenfist-client[vdi]

Usage

sf-client instance list
sf-client instance show <ref>
sf-client instance vdiconsole <ref>

The client reads its credentials from the environment (SHAKENFIST_NAMESPACE, SHAKENFIST_KEY, SHAKENFIST_API_URL), from ~/.shakenfist, or from /etc/sf/shakenfist.json.

Documentation

• VDI console access -- graphical consoles, the Kerbside proxy and direct paths, and viewer selection
• Namespace capacity claims -- claiming aggregate cluster capacity for a namespace, the two claim states, and what each refusal means
• ARCHITECTURE.md -- project structure and key components
• AGENTS.md -- guide for AI agents working on this codebase
• RELEASE-SETUP.md -- one-time release infrastructure setup