Skip to main content

CLI for Allowance OpenClaw MCP installation and diagnostics

Project description

allowance

allowance is a small CLI for OpenClaw setup only.

It signs the user in with OTP, mints an Allowance connection token, and installs hosted Allowance MCP into OpenClaw. It is intentionally not a second runtime surface for requests, cards, or allowance operations, and OpenClaw config is the only long-term secret store.

Install

Primary (npm):

npm install -g @allowance/cli

This npm package exposes the allowance command and bootstraps the Python runtime automatically. Prerequisite: Python 3.12+ on PATH (python3 or python).

Secondary (pipx):

pipx install allowance

Local source install:

pipx install .

Local development:

uv sync --dev
uv run allowance --help

CLI Help UX

The CLI supports:

allowance --help
allowance -h
allowance -help
allowance --version

Publish to npm

This repo supports npm publishing through GitHub Actions.

One-time setup

  1. Create the npm scope/org @allowance and grant maintainer access.
  2. Create an npm automation token with publish permission.
  3. Add it as a GitHub repository secret:
    • name: NPM_TOKEN
    • value: npm token string
  4. Current npm automation token expires on June 23, 2026. Rotate both the GitHub NPM_TOKEN secret and your local ~/.npmrc entry before that date.

Release flow

  1. Bump version in package.json.
  2. Commit and push main.
  3. Tag and push a npm release tag:
git tag npm-v0.1.1
git push origin npm-v0.1.1
  1. GitHub Action .github/workflows/publish-npm.yml runs and publishes @allowance/cli.

After workflow success, users can install with:

npm install -g @allowance/cli

Publish to PyPI

This repo also supports PyPI publishing for pipx users.

One-time setup

  1. Create a PyPI account for the maintainer/org.
  2. Create a project-scoped API token in PyPI.
  3. Add the token as a GitHub repository secret:
    • name: PYPI_API_TOKEN
    • value: pypi-...

Release flow

  1. Bump version in pyproject.toml.
  2. Commit and push main.
  3. Tag and push a version tag:
git tag v0.1.1
git push origin v0.1.1
  1. GitHub Action .github/workflows/publish-pypi.yml runs:
    • lint/type/test
    • build wheels/sdist
    • publish to PyPI

OpenClaw

All commands output JSON by default. Use --pretty for formatted JSON.

Command What It Does Use When
allowance openclaw install Prompts for email or phone, completes OTP bootstrap, mints an OpenClaw-attributed token, and installs hosted Allowance MCP config First-time setup or reinstall
allowance openclaw doctor Verifies OpenClaw availability, installed config, bearer wiring, and hosted MCP reachability Troubleshooting
allowance openclaw uninstall Removes the Allowance MCP entry from OpenClaw and best-effort revokes the configured token Cleanup

allowance openclaw install writes an OpenClaw MCP entry named allowance using:

  • hosted MCP URL from the Allowance API config when available
  • transport: "streamable-http"
  • Authorization: Bearer ak_...

Install accepts either:

allowance openclaw install --email you@example.com
allowance openclaw install --phone +14155551234

If no identifier flag is provided, the CLI prompts for an email address or E.164 phone number.

The CLI uses openclaw mcp set/show/unset instead of editing OpenClaw config files directly.

Global Flags

  • --api-base-url to target another environment for one invocation
  • --pretty for formatted JSON output

Example:

allowance --api-base-url http://127.0.0.1:8000 --pretty openclaw doctor

Configuration

  • ALLOWANCE_API_BASE_URL (default: https://api.useallowance.com)
  • ALLOWANCE_MCP_URL (default: https://mcp.useallowance.com)
  • ALLOWANCE_HTTP_TIMEOUT_SECONDS (default: 20)

Tests

./scripts/test_unit.sh
./scripts/test_smoke.sh
./scripts/test_all.sh

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

allowance-0.1.2.tar.gz (33.3 kB view details)

Uploaded Source

Built Distribution

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

allowance-0.1.2-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file allowance-0.1.2.tar.gz.

File metadata

  • Download URL: allowance-0.1.2.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for allowance-0.1.2.tar.gz
Algorithm Hash digest
SHA256 df11fc3a5f5ac05e5b2761fb1625b9ae7e67353870ae08a74aaf32998117ceb1
MD5 010180facebcbefcd6cef690d7dbd6ab
BLAKE2b-256 12e19d0701444f33e83c597a97a98cdd5acc9ea341c2835121ca4b786e803b0c

See more details on using hashes here.

File details

Details for the file allowance-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: allowance-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for allowance-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 717fc4209720c037e06c8656cac604b6666393384211d3247aa4f503b8db68f5
MD5 aba50d529d1db7a2e7c59d8b97992644
BLAKE2b-256 ed671cbb0f619584050f8d203368f5c5ee02259a29948a5d857b81d276acdbeb

See more details on using hashes here.

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