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:

# Clone the repository
git clone https://github.com/okc0mputex/Doclayer.git
cd Doclayer/cli-python

# 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]"

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, authenticate with your Doclayer account:

# Interactive login
doclayer auth login

# Or use an API key (get one from the web dashboard)
export DOCLAYER_API_KEY=dly_your_api_key_here
doclayer auth status

CLI Installation