Home

Installation

with pip recommended

clo is published as a Python package and can be installed with pip. Open up a terminal and install:

pip install clo

with git

clo can be pulled directly from GitHub by cloning the repository:

git clone https://github.com/leshaunj/clo

From there, install the theme and its dependencies with:

pip install -e .

This can be useful for managing multiple versions.

Quick Start

Jump right into it with a demo instance:

clo --demo

Saving demo credentials to .clorc

clo creates a demo instance and saves the connection/authentication values as *environment variables to a file in your working directory titled .clorc:

cat .clorc

CLO_INSTANCE="https://demo8.odoo.com"
CLO_DATABASE="demo_saas-163_ea9cad58c1db_1698358792"
CLO_USERNAME="admin"
CLO_PASSWORD="admin"

Now you can you begin performing clo operations.

Connection & Authentication

You can set the environment variables of .clorc to that of your own Odoo instance as well. While clo looks for .clorc by default, you can instruct it to use any file you want:

# path/to/env/file
CLO_INSTANCE="https://odoo.mine.com"
CLO_DATABASE="mydb"
CLO_USERNAME="admin"
CLO_PASSWORD="admin"

or:

clo --demo path/to/env/file

then:

clo --env path/to/env/file ...

Inline

You can set most of the connection/authentication requisites from the command line:

clo --inst https://odoo.mine.com --db mydb --user admin ...

Though, for security, your password must be provided either by the CLO_PASSWORD environment vairable:

CLO_PASSWORD="admin" clo --inst https://odoo.mine.com --db mydb --user admin ...

otherwise, clo will ask for it directly:

clo --inst https://odoo.mine.com --db mydb --user admin ...

WARN  | Environment file `.clorc` was not found.
Enter your Password (or API-Key):