Skip to main content

CLI and MCP server tools for Aspose PDF Cloud

Project description

APDF Cloud CLI + MCP Tools

APDF Cloud CLI exposes Aspose PDF Cloud storage and PDF operations through both a command-line interface and an MCP server.

Installation

Install from PyPI:

python -m pip install apdf-cloud-cli

Check that the CLI is available:

apdf-cloud-cli --help
apdf --help

For local development from a checkout:

python -m pip install -e ".[dev]"

Configuration

Set credentials before running CLI commands or the MCP server. The easiest local setup path is:

apdf auth login
apdf auth status
apdf auth test

You can also set credentials directly in your shell:

$env:ASPOSE_CLIENT_ID = "your-client-id"
$env:ASPOSE_CLIENT_SECRET = "your-client-secret"

Optional environment variables:

  • ASPOSE_STORAGE_NAME: default Aspose storage name.
  • ASPOSE_BASE_URL: alternate Aspose PDF Cloud base URL.
  • ASPOSE_SELF_HOST: set to 1, true, yes, or on for self-hosted use.

You can also create a local .env file. See .env.example for a template. Environment variables take precedence over .env values.

CLI Usage

The canonical executable is apdf-cloud-cli. A shorter apdf alias is also installed for convenience.

apdf-cloud-cli storage list /
apdf-cloud-cli auth status
apdf-cloud-cli auth test
apdf-cloud-cli storage upload .\sample.pdf /sample.pdf
apdf-cloud-cli storage download /sample.pdf .\sample.pdf
apdf-cloud-cli pdf merge /a.pdf /b.pdf merged.pdf
apdf-cloud-cli pdf extract-text sample.pdf --output sample.txt
apdf-cloud-cli mcp serve

MCP Usage

After installing the package, configure your MCP client to launch:

apdf-cloud-cli mcp serve

Codex MCP configuration examples are available in docs/mcp-config.md, with a copy-pasteable helper at examples/codex-mcp-config.toml.

Codex Prompts

Sample prompts for using this MCP server with Codex are in docs/codex-prompts.md.

Install as an Agent Skill

The package includes an apdf-cloud-mcp skill for Codex and Claude Code. Install the package first, then install the bundled skill:

python -m pip install apdf-cloud-cli
apdf-cloud-cli skill install codex
apdf-cloud-cli skill install claude-code

For Claude Code project-local installation:

apdf-cloud-cli skill install claude-code --project

Use --force to replace an existing installed copy. More details are in docs/agent-skill.md.

Development

Run the default unit test suite:

python -m pytest -q

Run live Aspose Cloud smoke tests only when you intentionally want to call the real API:

$env:ASPOSE_RUN_LIVE_TESTS = "1"
python -m pytest -q -m live

More live-test setup notes are in docs/live-tests.md.

Build and validate the package distributions:

python -m build
python -m twine check dist/*

Security

Never commit real credentials. Keep .env local, prefer short-lived environment variables in CI, and avoid pasting secrets into issue reports, test output, logs, or prompts. See docs/security.md.

Publishing

Publishing is handled by GitHub Actions with PyPI trusted publishing.

  1. In PyPI, add a trusted publisher for repository andruhovski/apdf-tools, workflow publish.yml, environment pypi, and project name apdf-cloud-cli.
  2. Update the version in pyproject.toml and src/apdf_cloud_cli/__init__.py.
  3. Push a matching version tag, for example:
git tag v0.2.0
git push origin v0.2.0

Stage 2 Roadmap

  • Split PDF files
  • Extract images from PDF files
  • Extract tables from PDF files

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

apdf_cloud_cli-0.3.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

apdf_cloud_cli-0.3.0-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file apdf_cloud_cli-0.3.0.tar.gz.

File metadata

  • Download URL: apdf_cloud_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for apdf_cloud_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 643f1a637d214a12d60cf7f7b3324e8b87802a0eb88890ecea70abf1cdee8894
MD5 6197f793d014c011d7539fef7aee4349
BLAKE2b-256 c8f228aa30fad71b9e59aa24fbe63dc6d9c5da48698c8762f86d03064a824fc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for apdf_cloud_cli-0.3.0.tar.gz:

Publisher: publish.yml on andruhovski/apdf-tools

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

File details

Details for the file apdf_cloud_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: apdf_cloud_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for apdf_cloud_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 903398f875b32d7870ca8140467e1d188d1ddafbaf04309705f3ca9c24c37143
MD5 cf5261582da57f51432519386b55a075
BLAKE2b-256 891d73a0df71fc4c6c35557083a83b4346a4e73e2586d0d9e1a8c824bcf292b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for apdf_cloud_cli-0.3.0-py3-none-any.whl:

Publisher: publish.yml on andruhovski/apdf-tools

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