feat(task): improve help table descriptions and fix typos
This commit is contained in:
1 file changed
+20
-20
@@ -14,7 +14,7 @@ help-table() {
|
||||
rows+=("Command|Option|Description")
|
||||
rows+=("===ENV===| | ")
|
||||
rows+=("copy-dotenv|<env><env>|Copy .env file.")
|
||||
rows+=("create-dotenv|<env><type>|Create .env file of type nextcloud, odoo, upgrade.")
|
||||
rows+=("create-dotenv|<env><type>|Create .env of type nextcloud, odoo, upgrade.")
|
||||
rows+=("edit-dotenv|<env>|Open .env file in default editor.")
|
||||
rows+=("list-dotenv||List .env files.")
|
||||
rows+=("load-dotenv|<env>|Load and export .env file.")
|
||||
@@ -29,28 +29,28 @@ help-table() {
|
||||
rows+=("checkout-git-folder|<branch><path>|Checkout git commit from .gitmodules.")
|
||||
rows+=("commit-git-folder|<message><path>|Commit all changes in path.")
|
||||
rows+=("clean-git-folder|<path>|Clean git folder.")
|
||||
rows+=("clone-git-folder|<branch>|Clone git folder listed in the .gitmodules file.")
|
||||
rows+=("download-git-folder|<grep>|Download git folder listed in the .gitmodules file.")
|
||||
rows+=("clone-git-folder|<branch>|Clone git folders from .gitmodules.")
|
||||
rows+=("download-git-folder|<grep>|Download git folders from .gitmodules.")
|
||||
rows+=("status-git-folder|<path>|Show status for git folder in path.")
|
||||
rows+=("list-git-folder|<path>|List path and url of git folders.")
|
||||
rows+=("pull-git-folder|<branch><path>|Pull all git folders listed in the .gitmodules file.")
|
||||
rows+=("pull-git-folder|<branch><path>|Pull git folders from .gitmodules.")
|
||||
rows+=("push-git-folder|<path>|Push all git folders in path.")
|
||||
rows+=("remove-git-folder|<path>|Remove git folders in path.")
|
||||
rows+=("ls-git-folder|<grep>|List git folders path space separated.")
|
||||
rows+=("reset-git-folder|<path>|Abort rebase and reset git folder.")
|
||||
rows+=("stage-git-folder|<path>|Stage all files in git folders in path.")
|
||||
rows+=("switch-git-folder|<branch><path>|Switch branch for all git folders from the .gitmodules file.")
|
||||
rows+=("switch-git-folder|<branch><path>|Switch branch for git folders in .gitmodules.")
|
||||
rows+=("sync-git-folder|<branch><path>|Switch, stash and pull all git folders.")
|
||||
rows+=("run-pre-commit|<path>|Run pre-commit in path.")
|
||||
rows+=("===DOCKER===| | ")
|
||||
rows+=("archive-docker-tags||Archive Docker image tags on hub older than 1 year.")
|
||||
rows+=("archive-docker-tags||Archive Docker image tags older than 1 year.")
|
||||
rows+=("build-odoo|[output]|Build Odoo Docker image.")
|
||||
rows+=("build-odoo-mailgate|[output]|Build Odoo Mailgate Docker image.")
|
||||
rows+=("build-odoo-upgrade|[output]|Build Odoo Upgrade Docker image.")
|
||||
rows+=("build-odoo-cli|[output]|Build Odoo CLI Docker image.")
|
||||
rows+=("login-docker|[user][token]|Setup Docker Hub login credentials.")
|
||||
rows+=("login-podman|[user][token]|Login into registry with podman.")
|
||||
rows+=("update-docker-hub-readme||Update Docker Hub repository READMEs from image folders.")
|
||||
rows+=("update-docker-hub-readme||Update Docker Hub READMEs from image folders.")
|
||||
rows+=("container-ps||List container processes.")
|
||||
rows+=("remove|[name]|Remove containers and volumes.")
|
||||
rows+=("test-image-script|<folder>|Test scripts of target Docker image folder.")
|
||||
@@ -70,13 +70,13 @@ help-table() {
|
||||
rows+=("load-language|<db>[lang]|Install language package in Odoo db.")
|
||||
rows+=("patch-database|<db>[path]|Apply sql file to database.")
|
||||
rows+=("reset-views|<db>[key]|Execute hard reset on views matching keys.")
|
||||
rows+=("set-admin|[db]|Sets the password for the first user in database.")
|
||||
rows+=("set-admin|[db]|Set password for first user in database.")
|
||||
rows+=("update-module|<db>[name,path]|Update target Odoo module.")
|
||||
rows+=("update-module-list|<db>|Update module list of Odoo database.")
|
||||
rows+=("===REVISION===| | ")
|
||||
rows+=("checkout-latest-revision|[version]|Checkout the latest revision of the Odoo version.")
|
||||
rows+=("checkout-revision|[revision]|Load Odoo revision env var and checkout git folders.")
|
||||
rows+=("commit-and-push-revision|[revision]|Commit all changes and tag with current revision.")
|
||||
rows+=("checkout-latest-revision|[version]|Checkout latest revision of Odoo version.")
|
||||
rows+=("checkout-revision|[revision]|Load revision env var and checkout folders.")
|
||||
rows+=("commit-and-push-revision|[revision]|Commit changes and tag with revision.")
|
||||
rows+=("create-revision|<revision>|Create new Odoo revision.")
|
||||
rows+=("list-revision||List available Odoo revisions.")
|
||||
rows+=("load-latest-revision|[version]|Load the latest revision of the Odoo version.")
|
||||
@@ -84,7 +84,7 @@ help-table() {
|
||||
rows+=("show-revision|[revision]|Show references of Odoo revision.")
|
||||
rows+=("===LLM===| | ")
|
||||
rows+=("commit-with-llm||Commit with llm generated commit message.")
|
||||
rows+=("update-with-llm|<glob><prompt>|Feed module files with prompt to LLM and apply file changes.")
|
||||
rows+=("update-with-llm|<glob><prompt>|Feed files to LLM with prompt and apply changes.")
|
||||
rows+=("===SNIPPETS===| | ")
|
||||
rows+=("create-snippet|<xml-id>|Create snippet from template.")
|
||||
rows+=("install-snippet|<env><path>|Install snippet definition.")
|
||||
@@ -104,7 +104,7 @@ help-table() {
|
||||
rows+=("set-addons-path||Set Odoo addons path env variable.")
|
||||
rows+=("===DATA===| | ")
|
||||
rows+=("export-website-data|[env]|Export website data from Odoo database.")
|
||||
rows+=("import-csv|<db>[path]|Import data from csv. Filename is PostgreSQL table name.")
|
||||
rows+=("import-csv|<db>[path]|Import csv. Filename is PostgreSQL table.")
|
||||
rows+=("import-website-data|[env]|Import website data to Odoo database.")
|
||||
rows+=("===DEVELOP===| | ")
|
||||
rows+=("create-module|<path>|Create new Odoo module from template.")
|
||||
@@ -115,10 +115,10 @@ help-table() {
|
||||
rows+=("generate-module-inherit-model|<path><model>|Generate inherited model in module folder.")
|
||||
rows+=("generate-module-views|<path><model>|Generate model views in module folder.")
|
||||
rows+=("generate-module-security|<path><model>|Generate model access file.")
|
||||
rows+=("generate-module-migration|<path>|Generate migration script for currentmodule version.")
|
||||
rows+=("generate-module-migration|<path>|Generate migration script for current version.")
|
||||
rows+=("generate-module-inherit-view|<path><ref><model>|Generate snippet for referefenced view.")
|
||||
rows+=("generate-module-report|<path><model>|Generate report for a model in module folder.")
|
||||
rows+=("generate-module-translation|<path>|Generate module translation and update with llm.")
|
||||
rows+=("generate-module-translation|<path>|Generate translation and update with llm.")
|
||||
rows+=("generate-module-wizard|<path><model>|Generate wizard for a model in module folder.")
|
||||
rows+=("generate-repo-docs|<path>|Generate repo files from template.")
|
||||
rows+=("===MODULE===| | ")
|
||||
@@ -138,7 +138,7 @@ help-table() {
|
||||
rows+=("generate-ssh-keys||Generate ssh key pair.")
|
||||
rows+=("generate-pg-ssl-keys||Generate PostgreSQL SSL key material.")
|
||||
rows+=("get-addons-path||Output addons path.")
|
||||
rows+=("get-modules|<path>[option]|Get list of modules in path. 'basename' or 'dirname'.")
|
||||
rows+=("get-modules|<path>[option]|List modules in path as 'basename' or 'dirname'.")
|
||||
rows+=("get-module-version|<path>|Get module version from manifest.")
|
||||
rows+=("get-module-checksum|<path>|Get module checksum.")
|
||||
rows+=("help|[grep]|Show help for commands.")
|
||||
@@ -184,11 +184,11 @@ help-table() {
|
||||
rows+=("prepare-migration-brach|<path><module><version>|Create migration branch for a module.")
|
||||
rows+=("migrate-module|<path>|Migrate module code to target Odoo version.")
|
||||
rows+=("backport-module|<path>|Backport module code to target Odoo version.")
|
||||
rows+=("run-openupgrade|<db>|Run Odoo OpenUpgrade scripts for target database.")
|
||||
rows+=("run-openupgrade|<db>|Run OpenUpgrade scripts for database.")
|
||||
rows+=("===JUPYTER===| | ")
|
||||
rows+=("init-odoo-jupyter|<path>|Init jypyter lab directory.")
|
||||
rows+=("start-odoo-jupyter|<path>[db]|Start juypter lab in directory.")
|
||||
rows+=("exec-odoo-jupyter|<path>[db]|Run juypter notebook with papermill.")
|
||||
rows+=("init-odoo-jupyter|<path>|Init jupyter lab directory.")
|
||||
rows+=("start-odoo-jupyter|<path>[db]|Start jupyter lab in directory.")
|
||||
rows+=("exec-odoo-jupyter|<path>[db]|Run jupyter notebook with papermill.")
|
||||
|
||||
for row in "${rows[@]}"; do
|
||||
IFS='|' read -r cmd opt desc <<< "$row"
|
||||
|
||||
Reference in new issue
Block a user