{ "version": "1.0.15", "commands": { "backup:create": { "id": "backup:create", "description": "Create a new resource backup", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate backup:create", "$ relate backup:create -e environment-name", "$ relate backup:create -t dbms" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "type": { "name": "type", "type": "option", "char": "t", "description": "The relate entity type", "required": true, "multiple": false, "options": [ "dbms", "project" ] } }, "args": { "entityNameOrId": { "name": "entityNameOrId", "description": "Entity id", "required": true } } }, "backup:list": { "id": "backup:list", "description": "List resource backups", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate backup:list", "$ relate backup:list -e environment-name", "$ relate backup:list --columns=entityType,entityId --no-header --no-truncate", "$ relate backup:list --sort=created" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "type": { "name": "type", "type": "option", "char": "t", "description": "The relate entity type", "multiple": false, "options": [ "dbms", "project" ] } }, "args": {} }, "backup:remove": { "id": "backup:remove", "description": "Remove a resource backup", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate backup:remove ", "$ relate backup:remove -e environment-name" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "backupId": { "name": "backupId", "description": "Backup ID", "required": true } } }, "backup:restore": { "id": "backup:restore", "description": "Restore resource from a backup", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate backup:restore ", "$ relate backup:restore -e environment-name", "$ relate backup:restore " ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "backupIdOrPath": { "name": "backupIdOrPath", "description": "Backup ID or path", "required": true }, "outputPath": { "name": "outputPath", "description": "destination of backup" } } }, "db:create": { "id": "db:create", "description": "Create a new database in a DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate db:create", "$ relate db:create -e environment-name", "$ relate db:create my-new-db -D started-dbms", "$ relate db:create my-new-db -D started-dbms -u dbms-user-with-system-db-access" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "user": { "name": "user", "type": "option", "char": "u", "description": "The Neo4j DBMS user to create the database with (needs to have access to the system database)", "multiple": false, "default": "neo4j" }, "dbms": { "name": "dbms", "type": "option", "char": "D", "description": "DBMS that will contain the new database (needs to be started and have an access token created)", "required": true, "multiple": false } }, "args": { "name": { "name": "name", "description": "database name" } } }, "db:drop": { "id": "db:drop", "description": "Drop a database from a DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate db:drop", "$ relate db:drop -e environment-name", "$ relate db:drop my-new-db -D started-dbms", "$ relate db:drop my-new-db -D started-dbms -u dbms-user-with-system-db-access" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "user": { "name": "user", "type": "option", "char": "u", "description": "The Neo4j DBMS user to drop the database with (needs to have access to the system database)", "multiple": false, "default": "neo4j" }, "dbms": { "name": "dbms", "type": "option", "char": "D", "description": "DBMS containing the database to drop (needs to be started and have an access token created)", "required": true, "multiple": false } }, "args": { "name": { "name": "name", "description": "database name" } } }, "db:dump": { "id": "db:dump", "description": "Dump data from database", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate db:dump", "$ relate db:dump -e environment-name", "$ relate db:dump dbms-containing-db-to-dump -d db-to-dump", "$ relate db:dump dbms-containing-db-to-dump -d db-to-dump -t /path/to/save/dump/file/to" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "database": { "name": "database", "type": "option", "char": "d", "description": "Database", "multiple": false, "default": "neo4j" }, "to": { "name": "to", "type": "option", "char": "t", "description": "Path and filename for dump (defaults to a \"dbmsName-db-date-time.dump\")", "multiple": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "db:exec": { "id": "db:exec", "description": "Execute a query against a database", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate db:exec -f /path/to/cypher/file", "$ relate db:exec -f /path/to/cypher/file -e environment-name", "$ relate db:exec dbms-containing-db-to-query -f /path/to/cypher/file -d db-to-query", "$ relate db:exec dbms-containing-db-to-query -f /path/to/cypher/file -d db-to-query --force" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "database": { "name": "database", "type": "option", "char": "d", "description": "Database", "multiple": false, "default": "neo4j" }, "from": { "name": "from", "type": "option", "char": "f", "description": "Cypher file to run", "required": true, "multiple": false }, "user": { "name": "user", "type": "option", "char": "u", "description": "DBMS user", "multiple": false, "default": "neo4j" } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "db:list": { "id": "db:list", "description": "List databases within a DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate db:list", "$ relate db:list -e environment-name", "$ relate db:list", "$ relate db:list --columns=name,role -u dbms-user --no-header --no-truncate", "$ relate db:list --sort=name", "$ relate db:list --filter=name=db-name --output=json" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "user": { "name": "user", "type": "option", "char": "u", "description": "The Neo4j DBMS user to list databases with (needs to have access to the system database)", "multiple": false, "default": "neo4j" }, "dbms": { "name": "dbms", "type": "option", "char": "D", "description": "DBMS containing the databases to list (needs to be started and have an access token created)", "required": true, "multiple": false } }, "args": {} }, "db:load": { "id": "db:load", "description": "Load data into a database from a dump", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate db:load -f /path/to/dump/file", "$ relate db:load -f /path/to/dump/file -e environment-name", "$ relate db:load dbms-containing-db-to-load-into -f /path/to/dump/file -d db-to-load-into", "$ relate db:load dbms-containing-db-to-load-into -f /path/to/dump/file -d db-to-load-into --force" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "database": { "name": "database", "type": "option", "char": "d", "description": "Database to load data into", "multiple": false, "default": "neo4j" }, "force": { "name": "force", "type": "boolean", "description": "Force load data (WARNING! this will erase any existing data)", "allowNo": false }, "from": { "name": "from", "type": "option", "char": "f", "description": "Dump to load data from", "required": true, "multiple": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "dbms:access-token": { "id": "dbms:access-token", "description": "Generate access token for a Neo4j >=4.x enterprise DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:access-token", "$ relate dbms:access-token -e environment-name", "$ relate dbms:access-token my-dbms", "$ relate dbms:access-token my-dbms -u dbms-user" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "user": { "name": "user", "type": "option", "char": "u", "description": "Neo4j DBMS user to create the token for", "multiple": false, "default": "neo4j" } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "dbms:add-tag": { "id": "dbms:add-tag", "description": "Tag a DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:add-tag dbmsId \"production\"" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true }, "tagName": { "name": "tagName", "required": true } } }, "dbms:info": { "id": "dbms:info", "description": "Show the status of one or more Neo4j DBMSs", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:info", "$ relate dbms:info -e environment-name", "$ relate dbms:info -x", "$ relate dbms:info --columns=id,name --no-header --no-truncate", "$ relate dbms:info --sort=name", "$ relate dbms:info --filter=name=my-dbms --output=json" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "onlineCheck": { "name": "onlineCheck", "type": "boolean", "description": "Check if the DBMS is online", "allowNo": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": { "dbmss": { "name": "dbmss", "description": "Names or IDs of Neo4j instances" } } }, "dbms:install": { "id": "dbms:install", "description": "Install a new Neo4j DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:install", "$ relate dbms:install --limited", "$ relate dbms:install -n my-new-dbms", "$ relate dbms:install 4.0.2 -n my-new-dbms", "$ relate dbms:install 4.0.2 -n my-new-dbms -e environment-name --no-caching" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "name": { "name": "name", "type": "option", "char": "n", "description": "Name to give the newly installed DBMS", "required": true, "multiple": false }, "noCaching": { "name": "noCaching", "type": "boolean", "description": "Prevent caching of the downloaded DBMS", "allowNo": false }, "limited": { "name": "limited", "type": "boolean", "description": "Display limited versions of DBMSs", "allowNo": false } }, "args": { "version": { "name": "version", "description": "Version to install (semver, url, or path)", "required": true } } }, "dbms:link": { "id": "dbms:link", "description": "Link to an existing DBMS installation\nLinking a DBMS enables relate to manage it.", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:link /path/to/target/dbms/dir \"related DBMS\"" ], "flags": { "confirm": { "name": "confirm", "type": "boolean", "char": "y", "description": "Confirm DBMS configuration changes", "required": true, "allowNo": false } }, "args": { "filePath": { "name": "filePath", "required": true }, "dbmsName": { "name": "dbmsName", "required": true } } }, "dbms:list": { "id": "dbms:list", "description": "List installed Neo4j DBMSs", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:list", "$ relate dbms:list -e environment-name", "$ relate dbms:list --columns=id,name --no-header --no-truncate", "$ relate dbms:list --sort=name", "$ relate dbms:list --filter=name=my-dbms --output=json" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "dbms:open": { "id": "dbms:open", "description": "Open a Neo4j DBMS's directory", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:open", "$ relate dbms:open -e environment-name", "$ relate dbms:open -L" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "log": { "name": "log", "type": "boolean", "char": "L", "description": "If set, log the path instead", "allowNo": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "dbms:remove-tag": { "id": "dbms:remove-tag", "description": "Remove tag from a DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:remove-tag dbmsId \"waiting for approval\"" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true }, "tagName": { "name": "tagName", "required": true } } }, "dbms:start": { "id": "dbms:start", "description": "Start one or more Neo4j DBMSs", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:start", "$ relate dbms:start my-dbms", "$ relate dbms:start my-dbms my-other-dbms", "$ relate dbms:start -e environment-name" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "dbmss": { "name": "dbmss", "description": "Names or IDs of Neo4j instances" } } }, "dbms:stop": { "id": "dbms:stop", "description": "Stop one or more Neo4j DBMSs", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:stop", "$ relate dbms:stop my-dbms", "$ relate dbms:stop my-dbms my-other-dbms", "$ relate dbms:stop -e environment-name" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "shutdown": { "name": "shutdown", "type": "boolean", "description": "Use the shutdown procedure, if available, to stop the DBMS (needed on Windows for a graceful stop)", "allowNo": false } }, "args": { "dbmss": { "name": "dbmss", "description": "Names or IDs of Neo4j instances" } } }, "dbms:uninstall": { "id": "dbms:uninstall", "description": "Uninstall a Neo4j DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:uninstall", "$ relate dbms:uninstall -e environment-name", "$ relate dbms:uninstall my-dbms", "$ relate dbms:uninstall my-dbms -u dbms-user" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "dbms:upgrade": { "id": "dbms:upgrade", "description": "Upgrade an installed DBMS to a newer version", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate dbms:upgrade", "$ relate dbms:upgrade -e environment-name", "relate dbms:upgrade -v 4.4.11" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "version": { "name": "version", "type": "option", "char": "v", "description": "Version to install (semver, url, or path)", "required": true, "multiple": false }, "noCaching": { "name": "noCaching", "type": "boolean", "description": "Prevent caching of the downloaded DBMS", "allowNo": false }, "noMigration": { "name": "noMigration", "type": "boolean", "description": "Prevent migrating the data to new formats", "allowNo": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "dbms-plugin:add-sources": { "id": "dbms-plugin:add-sources", "description": "Add one or more plugin sources", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "plugin:add-sources" ], "examples": [ "$ relate dbms-plugin:add-sources", "$ relate dbms-plugin:add-sources -e environment-name", "$ relate dbms-plugin:add-sources http://github.com/some/plugin/.neo4j-plugin-source", "$ relate dbms-plugin:add-sources ./local/.neo4j-plugin-source" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": { "sources": { "name": "sources", "description": "File path or URL to plugin sources" } } }, "dbms-plugin:install": { "id": "dbms-plugin:install", "description": "Install plugin on one or more Neo4j DBMSs", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "plugin:install" ], "examples": [ "$ relate dbms-plugin:install", "$ relate dbms-plugin:install dbms1 --plugin apoc", "$ relate dbms-plugin:install dbms1 dbms2 dbms3 --plugin apoc", "$ relate dbms-plugin:install -e environment-name" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "plugin": { "name": "plugin", "type": "option", "char": "p", "description": "Name of the plugin to install", "required": true, "multiple": false } }, "args": { "dbmss": { "name": "dbmss", "description": "Names or IDs of Neo4j instances" } } }, "dbms-plugin:list-sources": { "id": "dbms-plugin:list-sources", "description": "List available plugin sources", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "plugin:list-sources" ], "examples": [ "$ relate dbms-plugin:list-sources", "$ relate dbms-plugin:list-sources -e environment-name", "$ relate dbms-plugin:list-sources --columns=id,name --no-header --no-truncate", "$ relate dbms-plugin:list-sources --sort=name", "$ relate dbms-plugin:list-sources --filter=name=my-dbms --output=json" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "dbms-plugin:list": { "id": "dbms-plugin:list", "description": "List plugins installed in a Neo4j DBMS", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "plugin:list" ], "examples": [ "$ relate dbms-plugin:list MyDbms", "$ relate dbms-plugin:list MyDbms -e environment-name", "$ relate dbms-plugin:list MyDbms --columns=id,name --no-header --no-truncate", "$ relate dbms-plugin:list MyDbms --sort=name", "$ relate dbms-plugin:list MyDbms --filter=name=my-dbms --output=json" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "dbms-plugin:remove-sources": { "id": "dbms-plugin:remove-sources", "description": "Remove one or more plugin sources", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "plugin:remove-sources" ], "examples": [ "$ relate dbms-plugin:remove-sources", "$ relate dbms-plugin:remove-sources -e environment-name", "$ relate dbms-plugin:remove-sources sourceName", "$ relate dbms-plugin:remove-sources sourceName1 sourceName2" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false } }, "args": { "sources": { "name": "sources", "description": "Names of the plugin sources to remove" } } }, "dbms-plugin:uninstall": { "id": "dbms-plugin:uninstall", "description": "Uninstall plugin from one or more Neo4j DBMSs", "strict": false, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "plugin:uninstall" ], "examples": [ "$ relate dbms-plugin:uninstall", "$ relate dbms-plugin:uninstall dbms1 --plugin apoc", "$ relate dbms-plugin:uninstall dbms1 dbms2 dbms3 --plugin apoc", "$ relate dbms-plugin:uninstall -e environment-name" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "plugin": { "name": "plugin", "type": "option", "char": "p", "description": "Name of the plugin to uninstall", "required": true, "multiple": false } }, "args": { "dbmss": { "name": "dbmss", "description": "Names or IDs of Neo4j instances" } } }, "environment:api-token": { "id": "environment:api-token", "description": "Generate API token for HTTP access to Relate", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "env:api-token" ], "examples": [ "$ relate env:api-token", "$ relate env:api-token -e environment-name", "$ relate env:api-token my-app", "$ relate env:api-token my-app -h localhost:3000" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "hostName": { "name": "hostName", "type": "option", "char": "h", "description": "Client host name (if other than current environment)", "multiple": false } }, "args": { "clientId": { "name": "clientId", "description": "Client ID" } } }, "environment:init": { "id": "environment:init", "description": "Initialize a new relate environment", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "env:init" ], "examples": [ "$ relate env:init environment-name", "$ relate env:init environment-name --use", "$ relate env:init environment-name --interactive" ], "flags": { "interactive": { "name": "interactive", "type": "boolean", "char": "i", "description": "Get prompted for each configuration option available", "allowNo": false }, "use": { "name": "use", "type": "boolean", "description": "Set environment as active right after creating it", "allowNo": false }, "noRuntime": { "name": "noRuntime", "type": "boolean", "description": "Skip downloading the Java runtime required by the DBMS", "allowNo": false }, "apiToken": { "name": "apiToken", "type": "boolean", "description": "If this flag is provided and the environment created is set as active, all requests to @relate/web will require API tokens", "allowNo": false } }, "args": { "environment": { "name": "environment", "description": "Name of the environment to run the command against" } } }, "environment:list": { "id": "environment:list", "description": "List all available environments", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "env:list" ], "examples": [ "$ relate env:list" ], "flags": {}, "args": {} }, "environment:open": { "id": "environment:open", "description": "Open an environment's configuration with your default editor", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "env:open" ], "examples": [ "$ relate env:open", "$ relate env:open environment-name", "$ relate env:open environment-name -L" ], "flags": { "log": { "name": "log", "type": "boolean", "char": "L", "description": "If set, log the path instead", "required": false, "allowNo": false } }, "args": { "environment": { "name": "environment", "description": "Name of the environment to run the command against" } } }, "environment:use": { "id": "environment:use", "description": "Set an environment as default", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [ "env:use" ], "examples": [ "$ relate env:use environment-to-set-as-active" ], "flags": {}, "args": { "environment": { "name": "environment", "description": "Name of the environment to set as active", "required": true } } }, "project:add-dbms": { "id": "project:add-dbms", "description": "Add a DBMS connection to a project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:add-dbms", "$ relate project:add-dbms -e environment-name", "$ relate project:add-dbms -p my-project", "$ relate project:add-dbms -p my-project -n dbms-name-in-project -u dbms-user-to-create-token-for" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false }, "name": { "name": "name", "type": "option", "char": "n", "description": "Project DBMS name", "multiple": false }, "user": { "name": "user", "type": "option", "char": "u", "description": "Neo4j DBMS user to create the token for", "multiple": false, "default": "neo4j" } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "project:add-file": { "id": "project:add-file", "description": "Add a file to a project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:add-file", "$ relate project:add-file -e environment-name", "$ relate project:add-file -p my-project -d relative/path/to/dest.file /path/to/source.file", "$ relate project:add-file -p my-project -d /path/to/existing-dest.file /path/to/source.file --overwrite" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false }, "destination": { "name": "destination", "type": "option", "char": "d", "description": "The relative path of the file (including name) in the project", "multiple": false }, "overwrite": { "name": "overwrite", "type": "boolean", "description": "Overwrite existing destination file", "allowNo": false } }, "args": { "source": { "name": "source", "required": true } } }, "project:init": { "id": "project:init", "description": "Initialize a new project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:init /path/to/target/project/dir", "$ relate project:init /path/to/target/project/dir -e environment-name", "$ relate project:init /path/to/target/project/dir --name=my-project" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "name": { "name": "name", "type": "option", "description": "Name of the project to initialize", "required": true, "multiple": false } }, "args": {} }, "project:install-sample": { "id": "project:install-sample", "description": "Install sample project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:install-sample" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false }, "to": { "name": "to", "type": "option", "char": "t", "description": "Path where the project directory will be created.", "multiple": false } }, "args": {} }, "project:link": { "id": "project:link", "description": "Link a project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:link /path/to/target/project/dir" ], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "Name of the project", "required": true, "multiple": false } }, "args": { "filePath": { "name": "filePath", "required": true } } }, "project:list-dbmss": { "id": "project:list-dbmss", "description": "List project DBMS connections", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:list-dbmss", "$ relate project:list-dbmss -e environment-name", "$ relate project:list-dbmss -p my-project" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false } }, "args": {} }, "project:list-files": { "id": "project:list-files", "description": "List project files", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:list-files", "$ relate project:list-files -e environment-name", "$ relate project:list-files -p my-project", "$ relate project:list-files --ignore node_module --ignore dist", "$ relate project:list-files --ignore node_module,dist" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "ignore": { "name": "ignore", "type": "option", "char": "i", "description": "List of directories to ignore", "multiple": true, "default": [ "node_modules", ".git" ] }, "limit": { "name": "limit", "type": "option", "char": "l", "description": "Max number of files to list", "multiple": false } }, "args": {} }, "project:list": { "id": "project:list", "description": "List all projects", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:list", "$ relate project:list -e environment-name" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "project:open": { "id": "project:open", "description": "Open a project's folder", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:open", "$ relate project:open -e environment-name", "$ relate project:open -p my-project", "$ relate project:open -p my-project -L" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false }, "log": { "name": "log", "type": "boolean", "char": "L", "description": "If set, log the path instead", "allowNo": false } }, "args": {} }, "project:remove-dbms": { "id": "project:remove-dbms", "description": "Remove a DBMS connection from a project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:remove-dbms", "$ relate project:remove-dbms -e environment-name", "$ relate project:remove-dbms project-dbms-name", "$ relate project:remove-dbms project-dbms-name -p my-project" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false } }, "args": { "dbms": { "name": "dbms", "description": "Name or ID of a Neo4j instance", "required": true } } }, "project:remove-file": { "id": "project:remove-file", "description": "Remove a file from a project", "strict": true, "pluginName": "@relate/cli", "pluginAlias": "@relate/cli", "pluginType": "core", "aliases": [], "examples": [ "$ relate project:remove-file", "$ relate project:remove-file -e environment-name", "$ relate project:remove-file /project/path/to/name.file", "$ relate project:remove-file /project/path/to/name.file -p my-project" ], "flags": { "environment": { "name": "environment", "type": "option", "char": "e", "description": "Name of the environment to run the command against", "required": false, "multiple": false }, "project": { "name": "project", "type": "option", "char": "p", "description": "Name of the project to run the command against", "required": true, "multiple": false } }, "args": { "file": { "name": "file", "required": true } } } } }