From 7316152764a7df50b2510051374408c74a93554a Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Mon, 14 Mar 2022 10:36:16 +0000 Subject: [PATCH] [IMP] developer/cli: mention the different ways of calling the CLI All examples on the page suggest calling the CLI with "odoo-bin" while it is recommended to call it with "odoo" when Odoo was installed from a distribution package. It also failed to mention the location of "odoo-bin" relative to the source files. The chance is also taken to rename the somewhat unclear page title to something more clear and generic. closes odoo/documentation#1699 X-original-commit: c018a536869ff8b5a88ea742aa125036f41d4f45 Signed-off-by: Antoine Vandevenne (anv) --- content/administration/install/install.rst | 14 ++++---- content/developer/misc/other/cmdline.rst | 39 ++++++++++++++++++++-- 2 files changed, 43 insertions(+), 10 deletions(-) diff --git a/content/administration/install/install.rst b/content/administration/install/install.rst index 9b2bcb1b6..6dc822175 100644 --- a/content/administration/install/install.rst +++ b/content/administration/install/install.rst @@ -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 @@ -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 @@ -668,8 +666,10 @@ 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 `. .. _setup/install/docker: @@ -677,7 +677,7 @@ Docker ====== The full documentation on how to use Odoo with Docker can be found on the -official Odoo `docker image `_ page. +official Odoo `docker image `_ page. .. _Debian 11 (Bullseye): https://www.debian.org/releases/bullseye/ .. _demo: https://demo.odoo.com diff --git a/content/developer/misc/other/cmdline.rst b/content/developer/misc/other/cmdline.rst index 9a6167ad7..bf2cb8719 100644 --- a/content/developer/misc/other/cmdline.rst +++ b/content/developer/misc/other/cmdline.rst @@ -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 `, :ref:`launch Odoo as a Python console +environment `, :ref:`scaffold an Odoo module `, +:ref:`populate a database `, or :ref:`count the number of lines of code +`. + +.. 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 ` with the + :file:`odoo-bin` file. If you installed Odoo :ref:`from a distribution package + ` or :ref:`with 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 + `_. .. _reference/cmdline/help: @@ -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 ===== @@ -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 ====