Skip to main content

The official command-line interface for Pyplines

Project description

pyplines-cli

pyplines-cli is the command-line interface for Pyplines. The initial command surface supports local Function development through a running Pyplines Function development container. Server commands will use the same CLI in later releases.

Install

pip install pyplines-cli

Configuration

Configuration is YAML stored in the platform-native user configuration directory. Find the exact path with:

pyplines config path

Initial shape:

function_development:
  url: http://127.0.0.1:7331
  connect_timeout: 5
  operation_timeout: 1800

function:
  template:
    repository: https://github.com/pyplines/function-template.git
    ref: v1

Every setting can be overridden with a PYPLINES_ environment variable. Use double underscores for nested keys:

export PYPLINES_MODE=automation
export PYPLINES_FUNCTION_DEVELOPMENT__URL=http://127.0.0.1:7331
export PYPLINES_FUNCTION_DEVELOPMENT_TOKEN="<local-container-token>"

The token is environment-only and is not written to the configuration file.

Output

Rich interactive output is the default. It uses purpose-built tables for collections, compact detail views for resources, and syntax-highlighted valid JSON when inspecting structured documents.

Set the process-level mode to automation for compact JSON and NDJSON output:

PYPLINES_MODE=automation pyplines function status

Non-streaming operations emit one JSON document. Streaming operations emit one NDJSON event per line. Automation mode never emits styling, progress indicators, or explanatory text.

Function Development

Initialize from the configured, pinned Git template:

pyplines function init hello-world

Check, invoke, and package the Function mounted into the development container:

cd hello-world
pyplines function status
pyplines function check
pyplines function invoke --input name=Ada
pyplines function invoke --input-file inputs.yaml
pyplines function package

Invocation prints only the Function output by default. Follow the live operation when progress and Function logs are needed:

pyplines function invoke --input name=Ada --follow

In automation mode, ordinary invocation emits one compact JSON output value and --follow emits the complete NDJSON event stream.

function init uses the system Git client and honors existing credential helpers, SSH agents, proxies, and enterprise Git configuration. It does not execute template hooks or retain the template repository's .git directory.

Versioning

The CLI uses calendar versioning with Python-compatible prerelease identifiers:

YYYY.MONTH.REVISION{PRERELEASE}

For example, the 2026.7.1 release can progress through:

Version Meaning
2026.7.1a1 First alpha
2026.7.1a2 Second alpha
2026.7.1b1 First beta
2026.7.1rc1 First release candidate
2026.7.1 Stable release

Published versions are immutable. Corrections require another prerelease number. The revision advances for the next body of work released in the same month; the year and month follow the release date. Prerelease identifiers follow PEP 440.

Release history is maintained in the CLI changelog.

Project details


Download files

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

Source Distribution

pyplines_cli-2026.7.1a2.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

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

pyplines_cli-2026.7.1a2-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file pyplines_cli-2026.7.1a2.tar.gz.

File metadata

  • Download URL: pyplines_cli-2026.7.1a2.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyplines_cli-2026.7.1a2.tar.gz
Algorithm Hash digest
SHA256 1b0012cc605694682b200a9e7ab8a67edacfc3717345cb3c649849a188363633
MD5 6463021805515edb439707a8d239480b
BLAKE2b-256 9e40c6239ddac508bf4810987982986ff0506155f513cfa69d743f8802edf2f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyplines_cli-2026.7.1a2.tar.gz:

Publisher: publish-cli.yml on pyplines/pyplines

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

File details

Details for the file pyplines_cli-2026.7.1a2-py3-none-any.whl.

File metadata

File hashes

Hashes for pyplines_cli-2026.7.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 257dd6fc782fe764605fbf64e86f075f8cbbc359bb1c065007746c239e2193b1
MD5 cb9d3b5f8d800fc5385ce8d6353c8d48
BLAKE2b-256 8c5da38626ddceee789ebe852c601c0e3e7fa6be0977108d88c7ef033322253f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyplines_cli-2026.7.1a2-py3-none-any.whl:

Publisher: publish-cli.yml on pyplines/pyplines

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page