Skip to content

fpgmaas/justx

Repository files navigation

justx logo

Release Build status Supported Python versions PyPI - Downloads


justx is a TUI command launcher built on top of just. Define recipes once, run them anywhere.

justx TUI demo


Documentation  ·  PyPI


Installation

uv tool install justx   # recommended
# or
pip install justx

Prerequisite: the just binary must be available on $PATH.

Quickstart

1. Initialise your global recipe library:

justx init

This creates ~/.justx/ with a sample justfile to get you started. To pull in a richer set of ready-made recipes (git, docker, filesystem tools, and more), run:

justx init --download-examples

2. Launch the TUI:

justx

Browse your recipes with the arrow keys and press Enter to run one. Press q to quit.

Global recipes

justx supports global recipes; recipes that are available from anywhere on your machine, no matter which project you're in.

Global recipes are discovered automatically when you run justx. justx searches for the global justfile and also discovers all .just files in the ~/.justx/ directory. For example:

~/.justx/
├── git.just        # git workflows
├── docker.just     # container management
└── ssh.just        # remote connections

Where ~/.justx/docker.just might contain:

# Run a container interactively with a shell
shell image_tag:
    docker run --rm -it --entrypoint bash {{image_tag}}

You can also skip the TUI and run recipes directly with justx run:

# Run 'shell' from the global 'docker' source with `my-image` as the tag
# Equivalent to: just --justfile ~/.justx/docker.just --working-directory . shell my-image
justx run -g docker:shell my-image

Local recipes and modules

If you run justx from a directory that contains a justfile, its recipes appear automatically in the TUI. justx also supports just's native module system — any modules declared in your justfile are discovered and shown as separate sources.

# justfile
mod docker
mod deploy

test:
    pytest

For full details on file discovery, CLI reference, and example justfiles, see the documentation.

About

A TUI command launcher built on top of just. Define recipes once, run them anywhere.

Topics

Resources

License

Stars

Watchers

Forks

Packages