Intended Audience

This page describes who pycli is built for and what background knowledge you need to use it effectively. Understanding the intended audience helps you gauge whether pycli fits your use case and which parts of the documentation are most relevant to you.

Who this documentation is for

pycli is designed for developers who need to deploy stacks, manage configuration, and process orders programmatically. You may be integrating pycli into a backend service, automating deployments in a CI/CD pipeline, or building a client application that communicates with the orders API.

This documentation assumes you are comfortable with the following:

• Making HTTP requests and reading JSON responses
• Working with command-line tools in a terminal
• Basic familiarity with REST API conventions (methods, status codes, request bodies)

You do not need to be a Python expert to use pycli, though understanding JSON Schema and HTTP semantics will help you get the most out of the API surface.

Two surfaces, one audience

pycli ships two complementary interfaces aimed at the same developer audience:

• CLI — intended for operators and developers who deploy stacks or adjust configuration from a terminal or automation script.
• HTTP API — intended for developers building integrations or services that create, retrieve, or cancel orders at runtime.

Most users will interact with both surfaces at different points in their workflow: the CLI for infrastructure tasks and the API for order management.

What this documentation does not cover

This documentation does not cover how pycli is implemented internally, how to contribute to the project, or how to host the API service itself. If you are responsible for running the API server rather than consuming it, refer to your platform's deployment documentation.

The following examples illustrate the kind of tasks this documentation is written to support. They give you a quick sense of whether pycli matches your workflow.

Deploying a stack from the command line

pycli deploy --region us-east-1 production

A developer triggers a deployment to the production environment in the us-east-1 region.

Creating an order via the HTTP API

curl -X POST https://api.example.com/orders \
  -H 'Content-Type: application/json' \
  -d '{"amount": 1500, "currency": "USD"}'

A backend service submits a new order with an amount and currency. The API returns the created order object as JSON.

Listing orders with a filter

curl 'https://api.example.com/orders?status=paid&limit=10'

A developer or automated client retrieves up to 10 orders with a paid status.

If these workflows match what you are trying to accomplish, this documentation is written for you.

• Install pycli — Set up the CLI and confirm your environment is ready before running any commands.
• Deploy a stack — The primary CLI workflow; covers required flags and available options.
• Create an order — Entry point for the HTTP API; explains the request body schema and expected response.
• Authentication — > Note for reviewer: The source material does not describe an authentication mechanism for the HTTP API. If the API requires API keys, tokens, or another auth scheme, that detail should be documented here and linked from this page.