Skip to content

Commit

Permalink
Merge pull request #149 from peridio/ENG-1220
Browse files Browse the repository at this point in the history
granular bundles
  • Loading branch information
danielspofford authored Dec 22, 2023
2 parents 80a3001 + af3b4fb commit a6f8db6
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 1 deletion.
14 changes: 14 additions & 0 deletions src/docs/cli/artifacts/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```
Usage: peridio artifacts create [OPTIONS] --name <NAME> --organization-prn <ORGANIZATION_PRN>
Options:
--description <DESCRIPTION>
An arbitrary string attached to the resource. Often useful for displaying to users
--name <NAME>
The resource's name, meant to be displayable to users
--organization-prn <ORGANIZATION_PRN>
The PRN of the organization you wish to create the resource within
-h, --help
Print help
```
8 changes: 8 additions & 0 deletions src/docs/cli/artifacts/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```
Usage: peridio artifacts get --prn <PRN>
Options:
--prn <PRN> The PRN of the resource to get
-h, --help Print help
```
11 changes: 11 additions & 0 deletions src/docs/cli/artifacts/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```
Usage: peridio artifacts list [OPTIONS] --search <SEARCH>
Options:
--limit <LIMIT> Limit the length of the page
--order <ORDER> Specify whether the query is ordered ascending or descending
--search <SEARCH> A search query per the Peridio API's search query language. It is recommended to quote the value of this option
--page <PAGE> A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response (if not null) to request subsequent results
-h, --help Print help
```
10 changes: 10 additions & 0 deletions src/docs/cli/artifacts/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```
Usage: peridio artifacts update [OPTIONS] --prn <PRN>
Options:
--prn <PRN> The PRN of the resource to update
--description <DESCRIPTION> An arbitrary string attached to the resource. Often useful for displaying to users
--name <NAME> The resource's name, meant to be displayable to users
-h, --help Print help
```
2 changes: 1 addition & 1 deletion src/scripts/gen-cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function processCommandHelp(cmd) {
}

exec('peridio --version', (_error, stdout) => {
const requiredVersion = 'peridio 0.16.0 460ca4c'
const requiredVersion = 'peridio 0.17.0 dc90106'

if (stdout.includes(requiredVersion)) {
processCommandHelp([])
Expand Down

0 comments on commit a6f8db6

Please sign in to comment.