Skip to main content

Doclayer Command-Line Interface - Document Intelligence Platform CLI

Project description

Doclayer CLI

PyPI version Python 3.11+

The official Doclayer Command-Line Interface for interacting with the Doclayer document intelligence platform.

Installation

# Via pip
pip install doclayer-cli

# Or via pipx (recommended for isolated installation)
pipx install doclayer-cli

Quick Start

# Authenticate with your Doclayer account
doclayer auth login

# Process a document
doclayer ingest file invoice.pdf --project proj_123 --wait

# List available agents
doclayer agent list --category contracts

# Check billing usage
doclayer billing usage

Features

  • Complete Command Set: All Doclayer operations via CLI
  • Batch Ingestion: Process multiple documents with resume capability
  • Rich Output: Beautiful terminal formatting
  • Profile Management: Multiple environment profiles support
  • Secure Authentication: API key and OAuth support

Commands

Command Description
auth Authentication (login, logout, API keys)
agent Agent template management
billing Usage tracking and billing
model Model configuration
project Project management
document Document operations
workflow Workflow management
search Vector and graph search
template Template gallery
config Configuration management
ingest Batch ingestion workflows
status Job monitoring and verification

Configuration

The CLI stores configuration in ~/.doclayer/:

~/.doclayer/
└── config.json      # Configuration and profile settings

Sensitive credentials (API keys, tokens) are stored in ~/.doclayer/config.json on macOS, or in your system's keyring on Linux/Windows.

Credential Storage

Platform Default Storage Override
macOS Config file DOCLAYER_USE_KEYRING=1 to use Keychain
Linux System keyring DOCLAYER_NO_KEYRING=1 to use config file
Windows System keyring DOCLAYER_NO_KEYRING=1 to use config file

Note: On macOS, the system Keychain prompts for password on every CLI command, so we use file-based storage by default for better UX.

Environment Variables

Variable Description
DOCLAYER_API_KEY API key for authentication
DOCLAYER_BASE_URL Custom API endpoint (default: https://api.doclayer.ai)
DOCLAYER_PROFILE Active profile name
DOCLAYER_TOKEN Authentication token
DOCLAYER_NO_KEYRING Set to 1 to disable system keyring (Linux/Windows)
DOCLAYER_USE_KEYRING Set to 1 to enable system keyring (macOS)
DOCLAYER_VERBOSE Enable verbose output

Requirements

  • Python 3.11 or higher
  • pip or pipx

Documentation

Support

License

Copyright © 2024-2025 Doclayer. All Rights Reserved.

This software is proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software, via any medium, is strictly prohibited.

See the LICENSE file for full terms.

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

doclayer_cli-0.1.3.tar.gz (38.0 kB view details)

Uploaded Source

Built Distribution

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

doclayer_cli-0.1.3-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file doclayer_cli-0.1.3.tar.gz.

File metadata

  • Download URL: doclayer_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 38.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for doclayer_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 eb2b6c3a94ad0e11d1a393e39d480d42fc294ce2cab35da528c3efa1b4d6ddec
MD5 ebd3d42e71a8303f1a44a3a6bfb15347
BLAKE2b-256 037491e3c53c1b8ceca126fbfde56c2b921b53e116df4aa334ad4987d4854a21

See more details on using hashes here.

File details

Details for the file doclayer_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: doclayer_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for doclayer_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fca65992b642c6f7c596a7230231d01169daae716c6d266872d7a6b597df9754
MD5 12d3d9f87c737abf5db7eec8077cf2a2
BLAKE2b-256 30e307e00288f3454a40116be67a226f95b6304a2fe1ccba85f237fa911fab8e

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