Installation & Setup

Get the Doclayer CLI installed and configured on your system in under 5 minutes.

System Requirements

Python 3.11 or higher
pip or pipx package manager
macOS, Linux, or Windows (WSL recommended)

Installation Methods

Method 1: Via pip (Recommended)

The fastest way to install Doclayer CLI is using pip:

pip install doclayer-cli

Method 2: Via pipx (Isolated Installation)

For an isolated installation that won't conflict with other Python packages:

# Install pipx if you don't have it
pip install pipx
pipx ensurepath

# Install doclayer-cli
pipx install doclayer-cli

Method 3: Development Installation

For contributors or if you need the latest development version, contact us at support@doclayer.ai for access to the development repository.

# After getting repository access, clone and install:
# Create virtual environment
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in development mode with all extras
pip install -e ".[dev]"

Optional Dependencies

Install optional extras for additional functionality:

# Excel export support (CSV and JSON work out of the box)
pip install doclayer-cli[export]

# Or install openpyxl directly
pip install openpyxl

Extra	Feature
[export]	Excel (XLSX) export support via openpyxl
[dev]	Development and testing tools

Verify Installation

After installation, verify that the CLI is working correctly:

# Check version
doclayer version

# View available commands
doclayer --help

Shell Completion

Enable tab-completion for better productivity. Add one of these lines to your shell configuration:

Bash

# Add to ~/.bashrc
eval "$(_DOCLAYER_COMPLETE=bash_source doclayer)"

Zsh

# Add to ~/.zshrc
eval "$(_DOCLAYER_COMPLETE=zsh_source doclayer)"

Fish

# Add to ~/.config/fish/config.fish
eval (env _DOCLAYER_COMPLETE=fish_source doclayer)

Quick Authentication

After installation, set up authentication. The recommended method is using an API key from the dashboard:

# Recommended: Use API key from dashboard
# 1. Sign up at https://dashboard.doclayer.ai
# 2. Navigate to Settings > API Keys
# 3. Create a new API key and set it:
export DOCLAYER_API_KEY=dly_your_api_key_here

# Verify authentication
doclayer auth status

Alternative: You can also register and login directly via the CLI:

doclayer auth register  # New user
doclayer auth login     # Existing user

CLI Installation