Skip to main content

CLI tool for Dolibarr ERP/CRM REST API management

Reason this release was yanked:

update

Project description

cli-anything-dolibarr

A stateful command-line interface for managing Dolibarr ERP/CRM via its REST API. Supports third parties, products, invoices, orders, proposals, stock movements, warehouses, projects, tasks, and more.

Installation

pip install -e /path/to/agent-harness

Configuration

cli-anything-dolibarr config init

Or set environment variables:

export DOLIBARR_URL="https://your-dolibarr.example.com/api/index.php"
export DOLIBARR_API_KEY="your_api_key"

Usage

Third Parties (Customers/Companies)

# List all third parties
cli-anything-dolibarr thirdparties list

# Get a specific third party
cli-anything-dolibarr thirdparties get 42

# Create a third party (required: name)
cli-anything-dolibarr thirdparties create --name "Acme Corp"

# Update a third party
cli-anything-dolibarr thirdparties update 42 --town "New York" --phone "+1234567890"

# Delete a third party
cli-anything-dolibarr thirdparties delete 42

Products

# List products
cli-anything-dolibarr products list

# Get a specific product
cli-anything-dolibarr products get 7

# Create a product (required: ref, label)
cli-anything-dolibarr products create --ref "PROD-001" --label "Widget A"

# Update a product
cli-anything-dolibarr products update 7 --description "Updated description"

# Delete a product
cli-anything-dolibarr products delete 7

Invoices

# List invoices
cli-anything-dolibarr invoices list

# Get a specific invoice
cli-anything-dolibarr invoices get 15

# Create an invoice (required: socid)
cli-anything-dolibarr invoices create --socid 42

# Update an invoice
cli-anything-dolibarr invoices update 15 --note "Payment pending"

# Delete an invoice
cli-anything-dolibarr invoices delete 15

Orders

# List orders
cli-anything-dolibarr orders list

# Get a specific order
cli-anything-dolibarr orders get 23

# Create an order (required: socid, date)
cli-anything-dolibarr orders create --socid 42 --date "2026-01-15"

# Update an order
cli-anything-dolibarr orders update 23 --note "Expedited shipping"

# Delete an order
cli-anything-dolibarr orders delete 23

Proposals

# List proposals
cli-anything-dolibarr proposals list

# Get a specific proposal
cli-anything-dolibarr proposals get 31

# Create a proposal (required: socid)
cli-anything-dolibarr proposals create --socid 42

# Update a proposal
cli-anything-dolibarr proposals update 31 --note "Revised terms"

# Delete a proposal
cli-anything-dolibarr proposals delete 31

Stock Movements

# List stock movements
cli-anything-dolibarr stockmovements list

# Stock in (type=3, positive qty)
cli-anything-dolibarr stockmovements create --product-id 7 --warehouse-id 1 --qty 50

# Stock out (type=2, negative qty)
cli-anything-dolibarr stockmovements create --product-id 7 --warehouse-id 1 --qty -10

Warehouses

# List warehouses
cli-anything-dolibarr warehouses list

# Get a specific warehouse
cli-anything-dolibarr warehouses get 1

# Create a warehouse (required: label)
cli-anything-dolibarr warehouses create --label "Main Warehouse"

# Update a warehouse
cli-anything-dolibarr warehouses update 1 --town "Shanghai"

# Delete a warehouse
cli-anything-dolibarr warehouses delete 1

Projects

# List projects
cli-anything-dolibarr projects list

# Get a specific project
cli-anything-dolibarr projects get 5

# Create a project (required: title)
cli-anything-dolibarr projects create --title "Website Redesign"

# Update a project
cli-anything-dolibarr projects update 5 --description "Phase 2 started"

# Delete a project
cli-anything-dolibarr projects delete 5

Tasks

# List tasks
cli-anything-dolibarr tasks list

# Get a specific task
cli-anything-dolibarr tasks get 12

# Create a task (requires project context)
cli-anything-dolibarr tasks create --title "Design mockups" --project-id 5

# Update a task
cli-anything-dolibarr tasks update 12 --progress 75

# Delete a task
cli-anything-dolibarr tasks delete 12

Global Options

Option Description
--json Output in JSON format
--csv Output in CSV format
--url Override Dolibarr API URL
--api-key Override API key
--limit N Limit results to N items
--verify Enable SSL certificate verification
# Example: JSON output with limit
cli-anything-dolibarr products list --json --limit 5

# Example: CSV output
cli-anything-dolibarr invoices list --csv

# Example: Override URL and API key
cli-anything-dolibarr thirdparties list --url "https://your-dolibarr.example.com/api/index.php" --api-key "your_api_key"

REPL Mode

Start an interactive session for repeated commands without re-authenticating:

cli-anything-dolibarr repl

Inside the REPL, use commands directly:

dolibarr> thirdparties list
dolibarr> products get 7
dolibarr> exit

Environment Variables

Variable Description
DOLIBARR_URL Full API URL (e.g., https://your-dolibarr.example.com/api/index.php)
DOLIBARR_API_KEY API key from Dolibarr user settings
DOLIBARR_VERIFY_SSL Set to 1 or true to verify SSL

SQL Filters

Use the --sql-filter option to apply advanced filters on list commands:

# Filter by name pattern
cli-anything-dolibarr thirdparties list --sql-filter "(t.name:like:'Acme%')"

# Filter by date range
cli-anything-dolibarr invoices list --sql-filter "(t.datec:>=:'2026-01-01')"

# Combined filters
cli-anything-dolibarr products list --sql-filter "(t.toselect:=:1) and (t.status:=:1)"

# IN operator
cli-anything-dolibarr orders list --sql-filter "(t.status:IN:1,2,3)"

Operators: :=, :like:, :<, :>, :<=, :>=, :!=, :IN:, :NOTIN:

SSL Verification

By default, SSL verification is disabled (--no-verify) to support self-signed certificates common in self-hosted Dolibarr installations. To enable verification:

cli-anything-dolibarr --verify thirdparties list

Or set the environment variable:

export DOLIBARR_VERIFY_SSL="true"

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

cli_anything_dolibarr-1.0.0.tar.gz (71.2 kB view details)

Uploaded Source

Built Distribution

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

cli_anything_dolibarr-1.0.0-py3-none-any.whl (123.0 kB view details)

Uploaded Python 3

File details

Details for the file cli_anything_dolibarr-1.0.0.tar.gz.

File metadata

  • Download URL: cli_anything_dolibarr-1.0.0.tar.gz
  • Upload date:
  • Size: 71.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for cli_anything_dolibarr-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2de9409b6162ab53255562fd28f307fd39fa6bb0e9b3696c45245b3ce09fbe0e
MD5 84928d7537e6778bdfcf536b32b94503
BLAKE2b-256 697fe1be6add57a3724f6270ecaa893c3889c6adf441fc587fb4c34d4059d048

See more details on using hashes here.

File details

Details for the file cli_anything_dolibarr-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cli_anything_dolibarr-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80664f1ca641a10b1b21460d2a5daa75fe95e6c77f6be95d382a05d7372f3e75
MD5 0918f8919e830ba9d38533798ad522b9
BLAKE2b-256 90d3510c72ab25bf433255631be764f772a3eefc356de9f1aabd141e1f63d27c

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