{"id":59730,"date":"2016-09-21T06:06:56","date_gmt":"2016-09-21T06:06:56","guid":{"rendered":"http:\/\/webkul.com\/blog\/?p=59730"},"modified":"2025-11-06T13:19:05","modified_gmt":"2025-11-06T13:19:05","slug":"beginner-guide-odoo-clicommand-line-interface","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/beginner-guide-odoo-clicommand-line-interface\/","title":{"rendered":"A Beginner Guide For Odoo CLI (Command Line Interface)"},"content":{"rendered":"

This article gives an overview of how we as a developer work with Odoo Command-Line.
\nIn order to explain it, we have already installed the Odoo v9 series GitHub repository and created a custom configuration file (at \/opt\/odoo9.conf) with minimal configuration.<\/p>\n

Latest version Odoo 19<\/a> is here now, learn more about what new features it brings to this enterprise management software.<\/p>\n

\n
\n

Philosophy of\u00a0 Odoo scripts<\/h3>\n<\/div>\n
\n

There are 3 three script file available of command line access.<\/p>\n

    \n
  1. odoo.py(python scripts)<\/li>\n
  2. openerp-server(bash scripts)<\/li>\n
  3. openerp-gevent(bash scripts for gevent environment )<\/li>\n<\/ol>\n

    All these scripts file finally run:<\/p>\n

    import openerp\nopenerp.cli.main()\n<\/pre>\n
    So basically the execution of the scripts call the main method of openerp.cli<\/strong> which is responsible of running the openerp.service.server.start\u00a0<\/strong>using the the configuration parameter (from openerp.tools.config<\/strong>)<\/p>\n<\/div>\n<\/div>\n
    \n
    \n
    Let\u2019s start with odoo.py<\/h3>\n<\/div>\n
    \n
    We can get access of Odoo command line interface by running the odoo.py \u00a0script file \u00a0located at the parent directory of our Odoo folder.
    \nodoo.py is nothing but python script just like other bash\u00a0scripts openerp-server<\/strong> and openerp-gevent<\/strong>.<\/p>\n
    As while running the .\/odoo.py \u00a0i have yet not associated any custom configuration file\/parameters,that why\u00a0the Odoo is running with these default configuration (~\/.openerp_serverrc) as below:<\/p>\n
    {'addons_path': '\/opt\/odoo9\/openerp\/addons,\/opt\/odoo9\/addons',\n 'admin_passwd': 'admin',\n 'config': None,\n 'csv_internal_sep': ',',\n 'data_dir': '\/opt\/odoo9\/.local\/share\/Odoo',\n 'db_host': False,\n 'db_maxconn': 64,\n 'db_name': False,\n 'db_password': False,\n 'db_port': False,\n 'db_template': 'template1',\n 'db_user': False,\n 'dbfilter': '.*',\n 'debug_mode': False,\n 'demo': {},\n 'dev_mode': False,\n 'email_from': False,\n 'geoip_database': '\/usr\/share\/GeoIP\/GeoLiteCity.dat',\n 'import_partial': '',\n 'init': {},\n 'language': None,\n 'limit_memory_hard': 2684354560,\n 'limit_memory_soft': 2147483648,\n 'limit_request': 8192,\n 'limit_time_cpu': 60,\n 'limit_time_real': 120,\n 'list_db': True,\n 'load_language': None,\n 'log_db': False,\n 'log_db_level': 'warning',\n 'log_handler': [':INFO'],\n 'log_level': 'info',\n 'logfile': None,\n 'logrotate': False,\n 'longpolling_port': 8072,\n 'max_cron_threads': 2,\n 'osv_memory_age_limit': 1.0,\n 'osv_memory_count_limit': False,\n 'overwrite_existing_translations': False,\n 'pg_path': None,\n 'pidfile': None,\n 'proxy_mode': False,\n 'publisher_warranty_url': 'http:\/\/services.openerp.com\/publisher-warranty\/',\n 'reportgz': False,\n 'root_path': '\/opt\/odoo9\/openerp',\n 'save': None,\n 'server_wide_modules': None,\n 'smtp_password': False,\n 'smtp_port': 25,\n 'smtp_server': 'localhost',\n 'smtp_ssl': False,\n 'smtp_user': False,\n 'stop_after_init': False,\n 'syslog': False,\n 'test_commit': False,\n 'test_enable': False,\n 'test_file': False,\n 'test_report_directory': False,\n 'translate_in': None,\n 'translate_modules': ['all'],\n 'translate_out': None,\n 'unaccent': False,\n 'update': {},\n 'without_demo': False,\n 'workers': 0,\n 'xmlrpc': True,\n 'xmlrpc_interface': '',\n 'xmlrpc_port': 8069}\n\n\n\n\n<\/pre>\n
    Note:<\/strong> Odoo store the configuration data at openerp.tools.config.options<\/strong> in dict<\/strong> format,where keys represent the configuration parameters and values represent value of parameter.
    \nThe default configuration is store in openerp_serverrc <\/strong>placed at\u00a0$HOME\/. openerp_serverrc<\/strong>
    \nWe can override all \u00a0above mention default parameters manually from command line.<\/p>\n
    For getting the list of available parameters just use –help<\/strong> option \u00a0after .\/odoo.py as below:<\/p>\n
     .\/odoo.py --h\n\n<\/pre>\n
    \n
    \n
    \n
    xmlrpc\u00a0<\/strong>port & addons path<\/h3>\n<\/div>\n<\/div>\n
    <\/div>\n
    \n
    For changing the default port we can use –xmlrpc-port<\/strong> <port>
    \nand for changing\/adding the another addons path use –addons-path<\/strong> <directories><\/p>\n
    .\/odoo.py --xmlrpc-port 9069 --addons-path \/opt\/odoo9\/openerp\/addons,\/opt\/odoo9\/addons,\/opt\/odoo9\/customs\n\n\n<\/pre>\n<\/div>\n<\/div>\n
    \n
    \n
    Module installation using CLI<\/h3>\n<\/div>\n
    Odoo CLI also provide the commands -i <modules>, –init <modules><\/strong>\u00a0\u00a0for module installation as.<\/p>\n
    For installing the sale :<\/strong><\/p>\n
    .\/odoo.py -d odoo9db -i sale<\/pre>\n
    We can also install multiple module at once by placing the module name in comma separated<\/p>\n
    .\/odoo.py -d odoo9db -i sale , product<\/pre>\n<\/div>\n<\/div>\n
    \n
    \n
    Module updation using CLI<\/h3>\n<\/div>\n
    For module updation we can use -u <modules>, –update <modules><\/strong> as. In case you are planning to upgrade your existing Odoo platform to version 19, make sure to check out Odoo Data Migration<\/a> services.
    \nFor update\u00a0the sale :<\/strong><\/p>\n
    .\/odoo.py -d odoo9db -u website_sale<\/pre>\n<\/div>\n
    \n
    \n
    Using a custom configuration<\/h3>\n<\/div>\n
    Instead of passing the –xmlrpc-port<\/strong> and –addons-path<\/strong> \u00a0manually each time \u00a0while
    \nrunning the Odoo we can save the most common setting in config file and directly associated the configuration file \u00a0using \u00a0-c <config>, –config <config><\/strong> as below:<\/p>\n
    .\/odoo.py -c \/etc\/odoo9.conf<\/pre>\n
    Here is my odoo9.conf file:<\/p>\n
    addons_path = \/opt\/odoo9\/openerp\/addons,\/opt\/odoo9\/addons,\/opt\/odoo9\/custom\n#add one another addons path('\/opt\/odoo9\/custom')\nadmin_passwd= webkul,\n#change my admin_passwd to webkul\ndb_user = odoo9\n#associate my odoo9 db_user\nxmlrpc_port = 9069\n#change  xmlrpc_port to 9069\nlogfile=  \/var\/log\/odoo\/odoo9-server.log\n#add a separate logfile\nlogrotate = True\n#enabled log-rotation<\/pre>\n
    So here we don(t) need to pass the generic parameter manually each time , in case if it(s) need we can again pass specif parameters as per our requirement<\/p>\n<\/div>\n
    \n
    \n
    Module testing using CLI<\/h3>\n<\/div>\n
    Odoo provide mainly two type of parameters\u00a0for test driven development.<\/p>\n
      \n
    1. –test-enable (for all module tests)<\/li>\n
    2. –test-file(for particular module tests)<\/li>\n<\/ol>\n
      For testing all module in a database(<\/strong>odoo9db):<\/strong><\/p>\n
      \/odoo.py -c \/etc\/odoo9.conf -d odoo9db --test-enable<\/pre>\n
      Here we have pass our custom config file path using -c <\/strong>and database name using -d.
      \n<\/strong>
      \nFor testing particular module(sale) in a database(<\/strong>odoo9db):<\/strong><\/p>\n
      .\/odoo.py -c \/etc\/odoo9.conf -d odoo9db -u sale --test-file \/opt\/odoo9\/addons\/sale\/tests<\/pre>\n
      Here we have pass our custom config file path using -c <\/strong>and database name using -d <\/strong>and tests file of sale using –test-file\u00a0.<\/strong><\/p>\n
      NOTE<\/strong>\u00a0: we don’t need to pass –test-enable if you have used –test-file and also don’t forget to use -i\/-u<\/strong> while running test of particular module.<\/p>\n<\/div>\n<\/div>\n
      \n
      \n
      Other USEFUL Command<\/h3>\n<\/div>\n