Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions content/administration/install/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -646,8 +646,7 @@ A typical way to run the server would be:

Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
PostgreSQL login, `dbpassword` is the PostgreSQL password and `mydb` is the default database
to serve on `localhost:8069`. You can add other directory paths separated by a comma to
`addons` at the end of the `addons-path` option.
to serve on `localhost:8069`.

.. group-tab:: Linux

Expand All @@ -657,8 +656,7 @@ A typical way to run the server would be:
$ python3 odoo-bin --addons-path=addons -d mydb

Where `CommunityPath` is the path of the Odoo Community installation and `mydb` is the default
database to serve on `localhost:8069`. You can add other directory paths separated by a comma
to `addons` at the end of the `addons-path` option.
database to serve on `localhost:8069`.

.. group-tab:: Mac OS

Expand All @@ -668,16 +666,18 @@ A typical way to run the server would be:
$ python3 odoo-bin --addons-path=addons -d mydb

Where `CommunityPath` is the path of the Odoo Community installation and `mydb` is the default
database to serve on `localhost:8069`. You can add other directory paths separated by a comma
to `addons` at the end of the `addons-path` option.
database to serve on `localhost:8069`.

.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.

.. _setup/install/docker:

Docker
======

The full documentation on how to use Odoo with Docker can be found on the
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
official Odoo `docker image <https://hub.docker.com/_/odoo/>`_ page.

.. _Debian 11 (Bullseye): https://www.debian.org/releases/bullseye/
.. _demo: https://demo.odoo.com
Expand Down
39 changes: 36 additions & 3 deletions content/developer/misc/other/cmdline.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,40 @@

.. _reference/cmdline:

=============
CLI: odoo-bin
=============
============================
Command-line interface (CLI)
============================

The CLI :dfn:`command-line interface` offers several functionalities related to Odoo. You can use it
to :ref:`run the server <reference/cmdline/server>`, :ref:`launch Odoo as a Python console
environment <reference/cmdline/shell>`, :ref:`scaffold an Odoo module <reference/cmdline/scaffold>`,
:ref:`populate a database <reference/cmdline/populate>`, or :ref:`count the number of lines of code
<reference/cmdline/cloc>`.

.. important::
The command to use to call the CLI depends on how you installed Odoo. In the examples below, we
assume that you are :ref:`running Odoo from source <setup/install/source>` with the
:file:`odoo-bin` file. If you installed Odoo :ref:`from a distribution package
<setup/install/packaged>` or :ref:`with Docker <setup/install/docker>`, you must adapt the
command.

.. tabs::

.. tab:: Run Odoo from source

#. Navigate to the root of the directory where you downloaded the source files of Odoo
Community.
#. Run all CLI commands with :command:`./odoo-bin`

.. tab:: Odoo was installed from a distribution package

When Odoo was installed, an executable named `odoo` was added to your user's PATH. Replace
all occurrences of :command:`odoo-bin` with :command:`odoo` in the examples below.

.. tab:: Odoo was installed with Docker

Please refer to the `documentation of the official Docker image of Odoo
<https://hub.docker.com/_/odoo/>`_.

.. _reference/cmdline/help:

Expand Down Expand Up @@ -607,6 +638,7 @@ Here is a sample file:
http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix
.. _pyinotify: https://github.com/seb-m/pyinotify/wiki

.. _reference/cmdline/shell:

Shell
=====
Expand Down Expand Up @@ -689,6 +721,7 @@ generation of the model's records to test your modules in databases containing n

:ref:`reference/testing/populate`

.. _reference/cmdline/cloc:

Cloc
====
Expand Down