{"id":22542198,"url":"https://github.com/commercelayer/commercelayer-cli-plugin-resources","last_synced_at":"2025-03-28T07:43:19.182Z","repository":{"id":37799837,"uuid":"350631988","full_name":"commercelayer/commercelayer-cli-plugin-resources","owner":"commercelayer","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-12T16:52:42.000Z","size":1859,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-12T21:17:54.961Z","etag":null,"topics":["commercelayer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/commercelayer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-03-23T08:19:33.000Z","updated_at":"2024-05-17T16:21:43.143Z","dependencies_parsed_at":"2023-09-26T13:45:00.080Z","dependency_job_id":"758a1aaf-4492-4b5a-aa97-d6197154dc3f","html_url":"https://github.com/commercelayer/commercelayer-cli-plugin-resources","commit_stats":{"total_commits":284,"total_committers":3,"mean_commits":94.66666666666667,"dds":"0.052816901408450745","last_synced_commit":"290b4e848ea86394f4eb5ccda6f7e6409cb3f897"},"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercelayer%2Fcommercelayer-cli-plugin-resources","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercelayer%2Fcommercelayer-cli-plugin-resources/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercelayer%2Fcommercelayer-cli-plugin-resources/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercelayer%2Fcommercelayer-cli-plugin-resources/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commercelayer","download_url":"https://codeload.github.com/commercelayer/commercelayer-cli-plugin-resources/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245991560,"owners_count":20706126,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commercelayer"],"created_at":"2024-12-07T13:09:03.921Z","updated_at":"2025-03-28T07:43:19.175Z","avatar_url":"https://github.com/commercelayer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @commercelayer/cli-plugin-resources\n\nCommerce Layer CLI Resources plugin\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Version](https://img.shields.io/npm/v/@commercelayer/cli-plugin-resources.svg)](https://npmjs.org/package/@commercelayer/cli-plugin-resources)\n[![Downloads/week](https://img.shields.io/npm/dw/@commercelayer/cli-plugin-resources.svg)](https://npmjs.org/package/@commercelayer/cli-plugin-resources)\n[![License](https://img.shields.io/npm/l/@commercelayer/cli-plugin-resources.svg)](https://github.com/commercelayer/cli-plugin-resources/blob/master/package.json)\n[![CodeQL](https://github.com/commercelayer/commercelayer-cli-plugin-resources/actions/workflows/codeql.yml/badge.svg)](https://github.com/commercelayer/commercelayer-cli-plugin-resources/actions/workflows/codeql.yml)\n\n\u003c!-- toc --\u003e\n\n* [Usage](#usage)\n* [Commands](#commands)\n\u003c!-- tocstop --\u003e\n## Usage\n\u003c!-- usage --\u003e\n\n```sh-session\ncommercelayer COMMAND\n\ncommercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.\n```\n\u003c!-- usagestop --\u003e\nTo install as a Commerce Layer CLI plugin run the following command:\n\n```sh-session\n$ commercelayer plugins:install resources\n```\n\n## Commands\n\u003c!-- commands --\u003e\n\n* [`commercelayer resources`](#commercelayer-resources)\n* [`commercelayer resources:all RESOURCE`](#commercelayer-resourcesall-resource)\n* [`commercelayer resources:args`](#commercelayer-resourcesargs)\n* [`commercelayer resources:count RESOURCE`](#commercelayer-resourcescount-resource)\n* [`commercelayer resources:create RESOURCE`](#commercelayer-resourcescreate-resource)\n* [`commercelayer resources:delete RESOURCE [ID]`](#commercelayer-resourcesdelete-resource-id)\n* [`commercelayer resources:doc RESOURCE`](#commercelayer-resourcesdoc-resource)\n* [`commercelayer resources:fetch PATH [ID]`](#commercelayer-resourcesfetch-path-id)\n* [`commercelayer resources:filters`](#commercelayer-resourcesfilters)\n* [`commercelayer resources:get RESOURCE [ID]`](#commercelayer-resourcesget-resource-id)\n* [`commercelayer resources:history RESOURCE [ID]`](#commercelayer-resourceshistory-resource-id)\n* [`commercelayer resources:last RESOURCE`](#commercelayer-resourceslast-resource)\n* [`commercelayer resources:list RESOURCE`](#commercelayer-resourceslist-resource)\n* [`commercelayer resources:retrieve RESOURCE [ID]`](#commercelayer-resourcesretrieve-resource-id)\n* [`commercelayer resources:schema`](#commercelayer-resourcesschema)\n* [`commercelayer resources:update RESOURCE [ID]`](#commercelayer-resourcesupdate-resource-id)\n\n### `commercelayer resources`\n\nList all the available Commerce Layer API resources.\n\n```sh-session\nUSAGE\n  $ commercelayer resources [-h]\n\nFLAGS\n  -h, --help  Show CLI help.\n\nDESCRIPTION\n  list all the available Commerce Layer API resources\n\nEXAMPLES\n  $ cl-resources resources\n\n  $ cl-res resources\n\n  $ commercelayer resources\n\n  $ cl resources\n```\n\n_See code: [src/commands/resources/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/index.ts)_\n\n### `commercelayer resources:all RESOURCE`\n\nFetch all resources.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:all RESOURCE [-i \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc | -R]] [--curl ] [--node ]\n    [--save-args \u003cvalue\u003e] [--load-args \u003cvalue\u003e] [-w \u003cvalue\u003e...] [-s \u003cvalue\u003e...] [-x \u003cvalue\u003e | -X \u003cvalue\u003e] [-D ,|;|||TAB\n    [-C -f \u003cvalue\u003e...]] [-H \u003cvalue\u003e... ] [-b] [-e \u003cvalue\u003e... | ]\n\nARGUMENTS\n  RESOURCE  the resource type\n\nFLAGS\n  -C, --csv                 export fields in csv format\n  -D, --delimiter=\u003coption\u003e  the delimiter character to use in the CSV output file (one of ',', ';', '|', TAB)\n                            \u003coptions: ,|;|||TAB\u003e\n  -H, --header=\u003cvalue\u003e...   rename column headers defining a comma-separated list of values field:\"renamed title\"\n  -R, --raw                 print out the raw API response\n  -X, --save-path=\u003cvalue\u003e   save command output to file and create missing path directories\n  -b, --blind               execute in blind mode without prompt and progress bar\n  -e, --extract=\u003cvalue\u003e...  extract subfields from object attributes\n  -f, --fields=\u003cvalue\u003e...   comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...  comma separated resources to include\n  -j, --json                convert output in standard JSON format\n  -s, --sort=\u003cvalue\u003e...     define results ordering\n  -u, --unformatted         print unformatted JSON output\n  -w, --where=\u003cvalue\u003e...    comma separated list of query filters\n  -x, --save=\u003cvalue\u003e        save command output to file\n      --load-args=\u003cvalue\u003e   load previously saved command arguments\n      --save-args=\u003cvalue\u003e   save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  fetch all resources\n\nALIASES\n  $ commercelayer all\n  $ commercelayer ra\n  $ commercelayer res:all\n\nEXAMPLES\n  $ commercelayer resources:all customers -f id,email,customer_group -i customer_group -s updated_at\n\n  $ cl res:all customers -i customer_group -f customer_group -f customer_groups/name -w customer_group_name_eq=\"GROUP NAME\"\n\n  $ cl all customers -s -created_at --json\n```\n\n_See code: [src/commands/resources/all.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/all.ts)_\n\n### `commercelayer resources:args`\n\nShow all the saved command arguments.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:args [-D [-a \u003cvalue\u003e -o list|retrieve|create|update -r \u003cvalue\u003e]]\n\nFLAGS\n  -D, --delete              delete saved arguments associated to the alias\n  -a, --alias=\u003cvalue\u003e       the alias associated to saved command arguments\n  -o, --operation=\u003coption\u003e  the resource operation\n                            \u003coptions: list|retrieve|create|update\u003e\n  -r, --resource=\u003cvalue\u003e    the resource type\n\nDESCRIPTION\n  show all the saved command arguments\n\nALIASES\n  $ commercelayer res:args\n```\n\n_See code: [src/commands/resources/args.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/args.ts)_\n\n### `commercelayer resources:count RESOURCE`\n\nCount the number of existent resources.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:count RESOURCE [-w \u003cvalue\u003e...]\n\nARGUMENTS\n  RESOURCE  the resource type\n\nFLAGS\n  -w, --where=\u003cvalue\u003e...  comma separated list of query filters\n\nDESCRIPTION\n  count the number of existent resources\n\nALIASES\n  $ commercelayer count\n  $ commercelayer res:count\n  $ commercelayer rs:count\n\nEXAMPLES\n  $ commercelayer resources:count customers\n\n  cl count customers -w customer_group_name_eq=\u003ccustomer-group-name\u003e\n```\n\n_See code: [src/commands/resources/count.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/count.ts)_\n\n### `commercelayer resources:create RESOURCE`\n\nCreate a new resource.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:create RESOURCE [-i \u003cvalue\u003e...] [-f \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc | -R]]\n    [--curl ] [--node ] [-H ] [-Y ] [-D \u003cvalue\u003e | -a \u003cvalue\u003e... | -r \u003cvalue\u003e... | -m \u003cvalue\u003e... |  | -O \u003cvalue\u003e... | -J\n    \u003cvalue\u003e... | --load-args \u003cvalue\u003e | --save-args \u003cvalue\u003e] [-t \u003cvalue\u003e...]\n\nARGUMENTS\n  RESOURCE  the resource type\n\nFLAGS\n  -D, --data=\u003cvalue\u003e             the data file to use as request body\n  -H, --headers                  show response headers\n  -J, --json-object=\u003cvalue\u003e...   define a resource object attribute in JSON format (value enclosed in single quotes)\n  -O, --object=\u003cvalue\u003e...        define a resource object attribute\n  -R, --raw                      print out the raw API response\n  -Y, --headers-only             show only response headers\n  -a, --attribute=\u003cvalue\u003e...     define a resource attribute [name=value]\n  -f, --fields=\u003cvalue\u003e...        comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...       comma separated resources to include\n  -j, --json                     convert output in standard JSON format\n  -m, --metadata=\u003cvalue\u003e...      define a metadata attribute or a set of metadata attributes\n  -r, --relationship=\u003cvalue\u003e...  define a relationship with another resource\n  -t, --tags=\u003cvalue\u003e...          list of tags associated with the resource\n  -u, --unformatted              print unformatted JSON output\n      --load-args=\u003cvalue\u003e        load previously saved command arguments\n      --save-args=\u003cvalue\u003e        save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  create a new resource\n\nALIASES\n  $ commercelayer create\n  $ commercelayer rc\n  $ commercelayer res:create\n  $ commercelayer post\n\nEXAMPLES\n  $ commercelayer resources:create customers -a email=user@test.com\n\n  $ clayer res:create customers -a email=\"user@test-com\" -r customer_group=customer_groups/\u003ccustomerGroupId\u003e\n\n  $ cl create customers -a email=user@test.com -m meta_key=\"meta value\"\n\n  $ cl rc customers -D /path/to/data/file/data.json\n```\n\n_See code: [src/commands/resources/create.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/create.ts)_\n\n### `commercelayer resources:delete RESOURCE [ID]`\n\nDelete an existing resource.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:delete RESOURCE [ID] [-l curl|node [--doc | -R]] [--curl ] [--node ] [-H ] [-Y ]\n\nARGUMENTS\n  RESOURCE  the resource type\n  ID        id of the resources to delete (max 20)\n\nFLAGS\n  -H, --headers       show response headers\n  -R, --raw           print out the raw API response\n  -Y, --headers-only  show only response headers\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  delete an existing resource\n\nALIASES\n  $ commercelayer delete\n  $ commercelayer rd\n  $ commercelayer res:delete\n\nEXAMPLES\n  $ commercelayer resources:delete customers/\u003ccustomerId\u003e\n\n  $ cl delete customers \u003ccustomerId\u003e\n\n  $ cl rd customers \u003ccustomerId-1\u003e,\u003ccustomerId-2\u003e,\u003ccustomerId-3\u003e\n```\n\n_See code: [src/commands/resources/delete.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/delete.ts)_\n\n### `commercelayer resources:doc RESOURCE`\n\nOpen the default browser and show the online documentation for the resource.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:doc RESOURCE [-p object|create|retrieve|list|update|delete]\n\nARGUMENTS\n  RESOURCE  the resource for which you want to access the online documentation\n\nFLAGS\n  -p, --page=\u003coption\u003e  the doc page you want to access\n                       \u003coptions: object|create|retrieve|list|update|delete\u003e\n\nDESCRIPTION\n  open the default browser and show the online documentation for the resource\n\nALIASES\n  $ commercelayer res:doc\n  $ commercelayer doc\n\nEXAMPLES\n  $ commercelayer resources:doc customers\n\n  $ cl res:doc customers\n\n  $ cl doc customers -p create\n```\n\n_See code: [src/commands/resources/doc.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/doc.ts)_\n\n### `commercelayer resources:fetch PATH [ID]`\n\nRetrieve a resource or list a set of resources.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:fetch PATH... [ID...] [-i \u003cvalue\u003e...] [-f \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc | -R]]\n    [--curl ] [--node ] [--save-args \u003cvalue\u003e] [--load-args \u003cvalue\u003e] [-H ] [-Y ] [-x \u003cvalue\u003e | -X \u003cvalue\u003e] [-e \u003cvalue\u003e...\n    | ] [-w \u003cvalue\u003e...] [-p \u003cvalue\u003e] [-n \u003cvalue\u003e] [-s \u003cvalue\u003e...]\n\nARGUMENTS\n  PATH...  path (or URL) of the resource(s) to fetch\n  ID...    resource id\n\nFLAGS\n  -H, --headers             show response headers\n  -R, --raw                 print out the raw API response\n  -X, --save-path=\u003cvalue\u003e   save command output to file and create missing path directories\n  -Y, --headers-only        show only response headers\n  -e, --extract=\u003cvalue\u003e...  extract subfields from object attributes\n  -f, --fields=\u003cvalue\u003e...   comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...  comma separated resources to include\n  -j, --json                convert output in standard JSON format\n  -n, --pageSize=\u003cvalue\u003e    number of elements per page\n  -p, --page=\u003cvalue\u003e        page number\n  -s, --sort=\u003cvalue\u003e...     define results ordering\n  -u, --unformatted         print unformatted JSON output\n  -w, --where=\u003cvalue\u003e...    comma separated list of query filters\n  -x, --save=\u003cvalue\u003e        save command output to file\n      --load-args=\u003cvalue\u003e   load previously saved command arguments\n      --save-args=\u003cvalue\u003e   save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  retrieve a resource or list a set of resources\n\nALIASES\n  $ commercelayer fetch\n  $ commercelayer res:fetch\n  $ commercelayer rf\n\nEXAMPLES\n  $ commercelayer resources:fetch customers\n\n  $ commercelayer res:fetch customers\n\n  $ clayer res:fetch customers/\u003ccustomerId\u003e\n\n  $ cl fetch customers/\u003ccustomerId\u003e/\u003ccustomerRelationship\u003e\n\n  $ cl fetch customers/{customerId}/orders aBcdEkYWx\n```\n\n_See code: [src/commands/resources/fetch.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/fetch.ts)_\n\n### `commercelayer resources:filters`\n\nShow a list of all available filter predicates.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:filters\n\nDESCRIPTION\n  show a list of all available filter predicates\n\nALIASES\n  $ commercelayer res:filters\n\nEXAMPLES\n  $ commercelayer resources:filters\n\n  $ cl res:filters\n```\n\n_See code: [src/commands/resources/filters.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/filters.ts)_\n\n### `commercelayer resources:get RESOURCE [ID]`\n\nRetrieve a resource or list a set of resources.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:get RESOURCE... [ID...] [-i \u003cvalue\u003e...] [-f \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc |\n    -R]] [--curl ] [--node ] [--save-args \u003cvalue\u003e] [--load-args \u003cvalue\u003e] [-H ] [-Y ] [-w \u003cvalue\u003e...] [-p \u003cvalue\u003e] [-n\n    \u003cvalue\u003e] [-s \u003cvalue\u003e...] [-x \u003cvalue\u003e | -X \u003cvalue\u003e] [-e \u003cvalue\u003e... | ]\n\nARGUMENTS\n  RESOURCE...  the resource type\n  ID...        id of the resource to retrieve\n\nFLAGS\n  -H, --headers             show response headers\n  -R, --raw                 print out the raw API response\n  -X, --save-path=\u003cvalue\u003e   save command output to file and create missing path directories\n  -Y, --headers-only        show only response headers\n  -e, --extract=\u003cvalue\u003e...  extract subfields from object attributes\n  -f, --fields=\u003cvalue\u003e...   comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...  comma separated resources to include\n  -j, --json                convert output in standard JSON format\n  -n, --pageSize=\u003cvalue\u003e    number of elements per page\n  -p, --page=\u003cvalue\u003e        page number\n  -s, --sort=\u003cvalue\u003e...     define results ordering\n  -u, --unformatted         print unformatted JSON output\n  -w, --where=\u003cvalue\u003e...    comma separated list of query filters\n  -x, --save=\u003cvalue\u003e        save command output to file\n      --load-args=\u003cvalue\u003e   load previously saved command arguments\n      --save-args=\u003cvalue\u003e   save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  retrieve a resource or list a set of resources\n\nALIASES\n  $ commercelayer get\n  $ commercelayer res:get\n  $ commercelayer rg\n\nEXAMPLES\n  $ commercelayer resources:get customers\n\n  $ commercelayer res:get customers\n\n  $ clayer res:get customers/\u003ccustomerId\u003e\n\n  $ cl get customers \u003ccustomerId\u003e\n```\n\n_See code: [src/commands/resources/get.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/get.ts)_\n\n### `commercelayer resources:history RESOURCE [ID]`\n\nShow history of a resource.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:history RESOURCE [ID]\n\nARGUMENTS\n  RESOURCE  the resource type\n  ID        id of the resource to retrieve\n\nDESCRIPTION\n  show history of a resource\n\nALIASES\n  $ commercelayer versions\n  $ commercelayer history\n  $ commercelayer rh\n  $ commercelayer res:history\n\nEXAMPLES\n  $ commercelayer resources:history customers/\u003ccustomerId\u003e\n\n  $ commercelayer history customers \u003ccustomerId\u003e\n\n  $ cl res:hidtory customers \u003ccustomerId\u003e\n\n  $ clayer rh customers/\u003ccustomerId\u003e\n```\n\n_See code: [src/commands/resources/history.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/history.ts)_\n\n### `commercelayer resources:last RESOURCE`\n\nShow the last id of a resource type.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:last RESOURCE\n\nARGUMENTS\n  RESOURCE  the resource type\n\nDESCRIPTION\n  show the last id of a resource type\n\nALIASES\n  $ commercelayer last\n  $ commercelayer res:last\n\nEXAMPLES\n  $ commercelayer resources:last customers\n\n  $ commercelayer last customer\n\n  $ cl res:last customers\n```\n\n_See code: [src/commands/resources/last.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/last.ts)_\n\n### `commercelayer resources:list RESOURCE`\n\nFetch a collection of resources.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:list RESOURCE [-i \u003cvalue\u003e...] [-f \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc | -R]]\n    [--curl ] [--node ] [--save-args \u003cvalue\u003e] [--load-args \u003cvalue\u003e] [-H ] [-Y ] [-w \u003cvalue\u003e...] [-p \u003cvalue\u003e] [-n\n    \u003cvalue\u003e] [-s \u003cvalue\u003e...] [-x \u003cvalue\u003e | -X \u003cvalue\u003e] [-e \u003cvalue\u003e... | ]\n\nARGUMENTS\n  RESOURCE  the resource type\n\nFLAGS\n  -H, --headers             show response headers\n  -R, --raw                 print out the raw API response\n  -X, --save-path=\u003cvalue\u003e   save command output to file and create missing path directories\n  -Y, --headers-only        show only response headers\n  -e, --extract=\u003cvalue\u003e...  extract subfields from object attributes\n  -f, --fields=\u003cvalue\u003e...   comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...  comma separated resources to include\n  -j, --json                convert output in standard JSON format\n  -n, --pageSize=\u003cvalue\u003e    number of elements per page\n  -p, --page=\u003cvalue\u003e        page number\n  -s, --sort=\u003cvalue\u003e...     define results ordering\n  -u, --unformatted         print unformatted JSON output\n  -w, --where=\u003cvalue\u003e...    comma separated list of query filters\n  -x, --save=\u003cvalue\u003e        save command output to file\n      --load-args=\u003cvalue\u003e   load previously saved command arguments\n      --save-args=\u003cvalue\u003e   save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  fetch a collection of resources\n\nALIASES\n  $ commercelayer list\n  $ commercelayer rl\n  $ commercelayer res:list\n\nEXAMPLES\n  $ commercelayer resources:list customers -f id,email,customer_group -i customer_group -s updated_at\n\n  $ cl res:list customers -i customer_group -f customer_group -f customer_groups/name -w customer_group_name_eq=\"GROUP NAME\"\n\n  $ cl list customers -p 5 -n 10 -s -created_at --raw\n```\n\n_See code: [src/commands/resources/list.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/list.ts)_\n\n### `commercelayer resources:retrieve RESOURCE [ID]`\n\nFetch a single resource.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:retrieve RESOURCE [ID] [-i \u003cvalue\u003e...] [-f \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc | -R]]\n    [--curl ] [--node ] [--save-args \u003cvalue\u003e] [--load-args \u003cvalue\u003e] [-H ] [-Y ] [-x \u003cvalue\u003e | -X \u003cvalue\u003e] [-e \u003cvalue\u003e...\n    | ]\n\nARGUMENTS\n  RESOURCE  the resource type\n  ID        id of the resource to retrieve\n\nFLAGS\n  -H, --headers             show response headers\n  -R, --raw                 print out the raw API response\n  -X, --save-path=\u003cvalue\u003e   save command output to file and create missing path directories\n  -Y, --headers-only        show only response headers\n  -e, --extract=\u003cvalue\u003e...  extract subfields from object attributes\n  -f, --fields=\u003cvalue\u003e...   comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...  comma separated resources to include\n  -j, --json                convert output in standard JSON format\n  -u, --unformatted         print unformatted JSON output\n  -x, --save=\u003cvalue\u003e        save command output to file\n      --load-args=\u003cvalue\u003e   load previously saved command arguments\n      --save-args=\u003cvalue\u003e   save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  fetch a single resource\n\nALIASES\n  $ commercelayer retrieve\n  $ commercelayer rr\n  $ commercelayer res:retrieve\n\nEXAMPLES\n  $ commercelayer resources:retrieve customers/\u003ccustomerId\u003e\n\n  $ commercelayer retrieve customers \u003ccustomerId\u003e\n\n  $ cl res:retrieve customers \u003ccustomerId\u003e\n\n  $ clayer rr customers/\u003ccustomerId\u003e\n```\n\n_See code: [src/commands/resources/retrieve.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/retrieve.ts)_\n\n### `commercelayer resources:schema`\n\nShow the current CommerceLayer OpenAPI schema version used by the plugin.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:schema\n\nDESCRIPTION\n  show the current CommerceLayer OpenAPI schema version used by the plugin\n\nALIASES\n  $ commercelayer schema\n  $ commercelayer res:schema\n  $ commercelayer rs\n\nEXAMPLES\n  $ commercelayer schema\n\n  cl res:schema\n```\n\n_See code: [src/commands/resources/schema.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/schema.ts)_\n\n### `commercelayer resources:update RESOURCE [ID]`\n\nUpdate an existing resource.\n\n```sh-session\nUSAGE\n  $ commercelayer resources:update RESOURCE [ID] [-i \u003cvalue\u003e...] [-f \u003cvalue\u003e...] [-u -j] [-l curl|node [--doc | -R]]\n    [--curl ] [--node ] [-H ] [-Y ] [-D \u003cvalue\u003e | -a \u003cvalue\u003e... | -r \u003cvalue\u003e... | [-m \u003cvalue\u003e... | -M \u003cvalue\u003e...] |  |\n    | -O \u003cvalue\u003e... | -J \u003cvalue\u003e... | --load-args \u003cvalue\u003e | --save-args \u003cvalue\u003e] [-t \u003cvalue\u003e...]\n\nARGUMENTS\n  RESOURCE  the resource type\n  ID        id of the resource to update\n\nFLAGS\n  -D, --data=\u003cvalue\u003e                 the data file to use as request body\n  -H, --headers                      show response headers\n  -J, --json-object=\u003cvalue\u003e...       define a resource object attribute in JSON format (value enclosed in single quotes)\n  -M, --metadata-replace=\u003cvalue\u003e...  define a metadata attribute and replace every item already present in the remote\n                                     resource\n  -O, --object=\u003cvalue\u003e...            define a resource object attribute\n  -R, --raw                          print out the raw API response\n  -Y, --headers-only                 show only response headers\n  -a, --attribute=\u003cvalue\u003e...         define a resource attribute\n  -f, --fields=\u003cvalue\u003e...            comma separeted list of fields in the format [resourceType/]field1,field2,field3\n  -i, --include=\u003cvalue\u003e...           comma separated resources to include\n  -j, --json                         convert output in standard JSON format\n  -m, --metadata=\u003cvalue\u003e...          define a metadata attribute and merge it with the metadata already present in the\n                                     remote resource\n  -r, --relationship=\u003cvalue\u003e...      define a relationship with another resource\n  -t, --tags=\u003cvalue\u003e...              list of tags associated with the resource\n  -u, --unformatted                  print unformatted JSON output\n      --load-args=\u003cvalue\u003e            load previously saved command arguments\n      --save-args=\u003cvalue\u003e            save command data to file for future use\n\nDOCUMENTATION FLAGS\n  -l, --lang=\u003coption\u003e  show the CLI command in the specified language syntax\n                       \u003coptions: curl|node\u003e\n      --curl           show the equivalent cURL command of the CLI command\n      --doc            show the CLI command in a specific language\n      --node           show the equivalent Node SDK source code of the CLI command\n\nDESCRIPTION\n  update an existing resource\n\nALIASES\n  $ commercelayer update\n  $ commercelayer ru\n  $ commercelayer res:update\n  $ commercelayer patch\n\nEXAMPLES\n  $ commercelayer resources:update customers/\u003ccustomerId\u003e -a reference=referenceId\n\n  $ commercelayer res:update customers \u003ccustomerId\u003e -a reference_origin=\"Ref Origin\"\n\n  $ cl update customers/\u003ccustomerId\u003e -m meta_key=\"meta value\"\n\n  $ cl ru customers \u003ccustomerId\u003e -M meta_key=\"metadata overwrite\n\n  $ clayer update customers \u003ccustomerId\u003e -D /path/to/data/file/data.json\n\n  $ cl update order \u003corderId\u003e -r billing_address=addresses/\u003caddressId\u003e\n\n  $ cl update customer \u003ccustomerId\u003e -r customer_group=\u003ccustomerGroupId\u003e\n```\n\n_See code: [src/commands/resources/update.ts](https://github.com/commercelayer/commercelayer-cli-plugin-resources/blob/main/src/commands/resources/update.ts)_\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommercelayer%2Fcommercelayer-cli-plugin-resources","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommercelayer%2Fcommercelayer-cli-plugin-resources","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommercelayer%2Fcommercelayer-cli-plugin-resources/lists"}