Odoo Terminal - WebExtension

The BFG10k for Odoo developers

All the power of Odoo json-rpc in a really easy way!

This web extension adds a terminal-like to control Odoo (11 to 15). All implemented commands use the tools provided by the Odoo framework. An unwavering policy when developing this extension is to not modify or alter in any way the Odoo classes. This sometimes results in certain commands having reduced/increased capabilities depending on the Odoo version.

The terminal is fully initialized when it is first opened after loading the page. So the impact on page loading is minimal.

Downloads

Usage

When you visit a Odoo website, the browser action icon of the extension turn to enabled state. This indicates that the extension is ready to use in the current page.

Few commands aren't available on the frontend, use command 'help' to know the available commands.

You can toggle terminal using one of these options:

• Press CTRL + , (by default)
• Use extension browser action icon

Example Commands

Notice the usage of quotes when use parameters with spaces.

Notice that a list is an string of values separated by commas. Example: "5, 15, 8"

Notice that can call commands without 'named arguments', for example: create res.partner "name=Hipcut street='Mystery street'" The rule is that 'unnamed arguments' fill values following the order of the command arguments definition. So mix 'unnamed' with 'named' arguments can be done as long as the order is maintained.

Notice that can use "simple json" format instead of normal syntaxis. For example "{'keyA':'this is a value', 'keyB':42}" can be done in a simple way "keyA='this is a value' keyB=42"

Notes

• This extension have a "preferences" page where you can add commands to run on every session. This is useful for example to load a remote script to extend the 'terminal' features or declare custom aliases.
• This extension uses an internal context to extend the 'user context'. This 'terminal context' has by default the key 'active_test' = false (see issue #14 to get more information). This context only affects to terminal operations.
• The maximum buffered screen lines is set to 750. So, you can't see more than 749 records in the same query. This is necessary to avoid have a lot of nodes... One of the problems of use HTML elements to render the output :/

Advance Usage

+ Escaped Sequences

Reading the value of a "edit input" will get the string with the escaped slashes. So, when you write something like "this \_ is a test", the engine reads "this \\_ is a test". This is great for keeping escaped sentences unresolved.

But, this cause problems when you try to resolve them with "JSON.parse", because the engine resolves the escaped slashes and JSON.parse try to resolve "\_" and this result on an exception. See the valid escape sequences in JSON format:

So... the way to send escaped sequences is by using double-slashed escape sequences. You write something like "this \\_ is a test" and the engine reads "this \\\\_ is a test". In this case JSON.parse can unescape \\ to \.

Escaped quotes (\' and \") are special because they are truncated by the terminal. So, when you write "this \' is a test", the terminal reads "this ' is a test". If you need send this characters escaped you must use 'triple-slash': "this \\\' is a test".

+ Parameter Generators

You can use "parameter generator" to create values.

The anatomy of a generator is: $type[min,max], $type[max] or $type

For example:

• create a new record with a random string: create -m res.partner -v name='$STR[4,30]'
• print the current time: print -m $NOWTIME

Notice that 'date' min and max are the milliseconds since 1970/01/01

+ Positional replacements for aliases

You can define aliases to call commands with predefined values. This command can use positional replacements.

The anatomy of a positional replacement is: $num[default_value] or $num

For example:

• First positional replacement (without default value = empty): alias -n my_alias -c "print -m 'Hello, $1'"
• Fist position replacement with default value 'world': alias -n my_alias -c "print -m 'Hello, $1[world]'"
• A somewhat more complex: alias -n search_mod -c "search -m ir.module.module -f display_name -d '[[\"name\", \"=\", \"$1\"], [\"state\", \"=\", \"$2[installed]\"]]'"

+ Runners (subcommands)

You can execute "subcommands" to use the result in a new command call. The syntax of runners looks like =={command}, =={command}.key or =={command}[index].

For example: read -m res.users -i =={search -m res.users -f id}.id

+ Massive operations

Massive operations are possible using the command repeat. Print to screen is a expensive task, consider use the --slient argument to increase the performance.

Example: repeat -t 5000 -c "create -m res.partner -v 'name=\"$STR[12] (Test)\"'" --silent

Extension Permissions

Contributing

• contributing.md

Changelog

• CHANGELOG.md

License

Copyright Alexandre Díaz & contributors

AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)

All content under 'icons/' has its own licenses and original authors.