untaped 3.1.0

A batteries-included CLI framework for building standalone DevOps tools.

untaped

untaped is a batteries-included CLI framework for building standalone DevOps tools on cyclopts. It is an SDK, not an app: there is no central untaped command. You build a tool, depend on the SDK, and ship an independent CLI.

The SDK gives every tool, for free:

• Config — a shared ~/.untaped/config.yml with top-level active: / profiles:, per-profile SDK http / ui settings, and each tool's own profile settings plus tool-managed top-level state.
• Profiles — named overlays (dev, prod, homelab) and a --profile root option, built in.
• Themes — built-in theme presets for consistent terminal styling.
• Output — consistent --format json|yaml|table|raw|pipe and --columns, so commands compose. pipe is a self-describing NDJSON record stream another untaped tool can read back. emit(...) renders a single entity as a vertical detail view or a sequence as a collection, dispatching by shape.
• HTTP / UI helpers — an HttpClient with profile-aware TLS, automatic retries for transient failures (RetryPolicy), and pagination helpers, plus a UiContext for messages, prompts, and progress.
• Config tooling — <tool> config doctor diagnoses the shared file and <tool> config edit opens it in $VISUAL/$EDITOR; a --quiet root option mutes progress and success/info chatter.
• Installed version reporting — <tool> --version prints the tool's own installed distribution version, not the SDK version.

You import the surface from untaped.api (re-exported from the untaped package root), declare a ToolSpec, and call run_tool(app, spec) from your tool's main(). The contract surface is the __all__ list in src/untaped/api.py.

# my_tool/__main__.py
from untaped.api import create_app, run_tool, ToolSpec
from my_tool.settings import MyProfile

app = create_app(...)

def main() -> None:
    run_tool(app, ToolSpec(
        command="untaped-mytool",
        section="mytool",
        profile_model=MyProfile,
    ))

# pyproject.toml
[project]
dependencies = [
    "untaped>=3.1.0,<4",
]

[project.scripts]
untaped-mytool = "my_tool.__main__:main"

run_tool wires --version to installed package metadata. By default, ToolSpec.distribution uses command; when the executable and distribution names differ, set the package explicitly, for example ToolSpec(command="acme", ..., distribution="acme-cli"). Metadata lookup is lazy, so it happens only for --version, whose stdout remains the version alone (for example, 0.4.2).

Tools resolve the SDK from PyPI in development and CI alike. Published wheels are built with uv build --no-sources as defense in depth, so package metadata always resolves from the declared PyPI range.

Requirements

Python 3.14 and uv.

The suite

Seven tools are built on the SDK. Each is an independent CLI installed into its own uv tool environment. As each PyPI-backed tool completes its first package release, install it by package name:

uv tool install untaped-github
uv tool install untaped-jira
uv tool install untaped-awx
uv tool install untaped-ansible
uv tool install untaped-workspace
uv tool install untaped-recipe
uv tool install git+https://github.com/alexisbeaulieu97/untaped-apple-health.git

untaped-apple-health is outside the current PyPI release wave; install it from git until that repo owns a package release workflow.

Because every tool reads the same ~/.untaped/config.yml and shares the same --format pipe envelope, independently installed tools interoperate and compose:

untaped-awx job-templates list --format raw --columns name \
  | fzf \
  | untaped-awx job-templates get --stdin --format json

Documentation

User-facing docs live in docs/:

• Building a tool with the untaped SDK — the guide to declaring a ToolSpec, wiring run_tool, and packaging an independent CLI.
• Configuration — the ~/.untaped/config.yml format, profiles, secrets, and TLS.
• Agent Skills — how each tool ships and installs Codex/Claude agent skills.
• Releasing — PyPI/TestPyPI workflow, Trusted Publisher setup, and recovery rules.
• Architecture decisions — the settled ADRs behind the SDK-only direction.

Per-tool command references live in each tool's own repo:

• GitHub
• Jira
• AWX / AAP
• Ansible
• Workspaces
• Recipe
• Apple Health

Security

Please report suspected vulnerabilities privately. See SECURITY.md.

Contributing

See CONTRIBUTING.md and AGENTS.md for the local workflow, architecture rules, and recipes for extending the SDK and its tools.

License

MIT. See LICENSE.