cliyard

CLI + YAML + Yard — a framework that generates CLI commands from YAML specs. Define your REST API in a few YAML files, and cliyard produces a fully-structured Click CLI with parameters, types, response formatting, and auto-generated help.

Installation

pip install cliyard

# Or for development
pip install -e .

Quick Start

# Generate a CLI from spec files
cliyard gen --name mycli --defs-path ./specs/
cd mycli && pip install -e .

# Use it
mycli --help
mycli repos list --page-size 10

How It Works

cliyard turns a directory of YAML files into CLI commands. One directory equals one API service. Each YAML file becomes a resource group with subcommands for every defined method.

specs/
├── _auth.yaml              # Service config: name, servers, auth chain
├── _groups.yaml            # (optional) Group definitions for nesting
├── _flows.yaml             # (optional) Flow orchestration index
├── resources/              # Resource YAML files
│   ├── repos.yaml
│   └── ...
├── flows/                  # (optional) Flow step definitions
│   ├── _flow_create_repo.yaml
│   └── ...
└── plugins/                # Python plugins
    └── *.py

Data flow for a single invocation:

CLI input → bind & validate → auth chain → assemble request → HTTP call → format response

Features

YAML-driven: Add a new API resource by creating a .yaml file, no code changes
Plugin system: 7 extension points for auth, types, hooks, methods, commands, field resolvers, flow steps
Flow orchestration: Define multi-step workflows with conditional branching, loops, and lifecycle hooks
Multi-server: Support multiple API endpoints in a single CLI
Rich output: Tables, JSON, CSV formatting with datetime conversion
Resource grouping: Nest related commands under parent groups

Examples

See the examples/ directory for ready-to-use spec sets:

examples/demo/ — Pet Store API demo with resource commands, plugins, and flow orchestration

# Library mode (read YAML at runtime)
python3 -c "from cliyard.runtime import create_cli; create_cli('examples/demo')()"

# Flow orchestration
petstore flow list
petstore flow run add-user --name 张三
petstore flow run retry-demo
petstore flow run plugin-demo
petstore flow run hook-demo

Documentation

Generated CLI projects include a README.md with full usage docs covering:

Usage & environment management
Adding new resources
Plugin authoring (all 7 plugin types)
Flow orchestration with conditional branching, loops, and hooks
Multi-server configuration
Custom method plugins

License

MIT

Download files

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

Source Distribution

cliyard-0.5.1.tar.gz (89.7 kB view details)

Uploaded Jul 29, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cliyard-0.5.1-py3-none-any.whl (83.6 kB view details)

Uploaded Jul 29, 2026 Python 3

File details

Details for the file cliyard-0.5.1.tar.gz.

File metadata

Download URL: cliyard-0.5.1.tar.gz
Upload date: Jul 29, 2026
Size: 89.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for cliyard-0.5.1.tar.gz
Algorithm	Hash digest
SHA256	`9ab70d05829c2b19b1053d23f2219edbdc065666ca8ae6564bbe84573c027060`
MD5	`ffc5663abe6d12247f96728f4e54689a`
BLAKE2b-256	`9df034bbd8d0b5c722c7a0a19ea4e2327365a4ae3cecceab13d575a20ef69774`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cliyard-0.5.1.tar.gz:

Publisher: publish.yml on guolong123/cliyard

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: cliyard-0.5.1.tar.gz
- Subject digest: 9ab70d05829c2b19b1053d23f2219edbdc065666ca8ae6564bbe84573c027060
- Sigstore transparency entry: 2279743454
- Sigstore integration time: Jul 29, 2026
Source repository:
- Permalink: guolong123/cliyard@5b4e9c2eee5dcc543eb88cc146de08ff41db5a78
- Branch / Tag: refs/tags/v0.5.1
- Owner: https://github.com/guolong123
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@5b4e9c2eee5dcc543eb88cc146de08ff41db5a78
- Trigger Event: release