Skip to main content

pyclisteno

A learned shortcut, hint, and completion layer for Python CLIs built on Click or Typer.

Stenography compresses language by rule rather than by lookup table, which is why trained stenographers reach speed without memorising a second vocabulary. clisteno does the same thing to a command tree: the short form of a command is a literal prefix of the long form, so typing dectl sa gl so ru is typing dectl salesdata glue source-copy run with less of it, not typing an alias that has to be learned separately.

What it provides

Three surfaces over one model, each independently opt-in:

  • Teaching — the short form and its description shown beside the long form in help output, so ordinary use trains the fast path.
  • Prediction — grammar-aware ghost text in the shell, driven by a cached index rather than by history.
  • Compression — a resolver that expands a prefix sequence into the full command.

Attaching it

Enrollment is one call after the command tree is complete. It is not a decorator on each command, because a tree assembled at runtime from config has no functions to decorate:

from pyclisteno import attach

app = typer.Typer()
# ... build the tree, including anything driven by config ...
attach(app)

Removing the library is deleting those two lines. Commands are never modified, and the CLI's behaviour with attach() is byte-identical without it — stdout, stderr, and exit codes — which is asserted by the test suite rather than assumed.

Decorators exist only for exceptions:

@app.command()
@shortcut('ru')  # pin, rather than accept the computed prefix
def run(): ...


@app.command()
@no_shortcut  # keep a destructive verb off the fast path
def destroy(): ...

How prefixes are assigned

Each node gets the shortest prefix of its own name that is unambiguous among its siblings, so run and review become ru and re. Assignments are recorded and grandfathered: once a prefix has been handed out it is never shortened, lengthened, or reassigned, because the whole point is protecting a sequence already in someone's fingers. Resolution is longest-match, which is what lets an incumbent r coexist with a later re. A removed command's prefix is retired permanently rather than recycled — a recycled sequence still works and silently does something else, which is the worst failure available here.

Where it keeps things

Path What Class
$XDG_CONFIG_HOME/<tool>/clisteno-shortcuts.toml User pins Config — you write it, nothing else does
$XDG_STATE_HOME/clisteno/<tool>.json The assignment ledger State — synced, so a sequence means the same thing on every machine
$XDG_CACHE_HOME/clisteno/<tool>.json The grammar model Cache
$XDG_CACHE_HOME/clisteno/<tool>.tsv Flat index for the shell Cache

The config file sits beside the tool's own config and is never merged into it, so the tool never parses shortcuts and never needs to know this library exists.

Related

goclisteno and bashclisteno implement the same grammar schema and the same assignment algorithm for their ecosystems, in the way goselfupdate / pyselfupdate / bashselfupdate share one release contract.

Release files for pyclisteno 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyclisteno 0.5.0
File Size Uploaded
pyclisteno-0.5.0.tar.gz 17.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyclisteno 0.5.0
File Interpreter ABI Platform
pyclisteno-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 38.3 kB

Release files / pyclisteno-0.5.0.tar.gz

Download URL pyclisteno-0.5.0.tar.gz
Size 17.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c1cca33c9279f23bc7ff4b711b839d0f0cdbe8699578c5c05c1cf0331f2fe2cf
BLAKE2b-256 checksum
How to use checksums
4cdfad73366f323f7fddb7504e4a7f34bc40bb3f0a514b6599ceb02bcdf183f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pyclisteno-0.5.0-py3-none-any.whl

Download URL pyclisteno-0.5.0-py3-none-any.whl
Size 21.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
93705f9c5ee961c4c4fa9d03d864d402fb3e51cd879b8f38d0b7d1a3e247e0d1
BLAKE2b-256 checksum
How to use checksums
060b51d3dbff37a0c311c2cba999f12ac6bec0cc70389673f8ecf842780eebf4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.8.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page