Merge pull request #634 from reubenmiller/docs-update-docs-for-release-2.54

docs: update docs for release 2.54

Author: reubenmiller

README.md

@@ -24,6 +24,56 @@ See the following installation instructions
 * [PowerShell](https://goc8ycli.netlify.app/docs/installation/powershell-installation)
 
 
+## Testing an unreleased version
+
+These instructions are for testing a version that has not yet been officially released, for example directly from a pull request or a specific commit. Go >= 1.25 must be installed on your machine.
+
+### Install
+
+1. Install `c8y` from a specific commit (replace the commit hash with the one you want to test)
+
+    ```sh
+    go install github.com/reubenmiller/go-c8y-cli/v2/cmd/c8y@<commit-or-branch>
+    ```
+
+    For example, to install from a specific commit:
+
+    ```sh
+    go install github.com/reubenmiller/go-c8y-cli/v2/cmd/c8y@7aace7646dfcb7c2a632da85e869daf99c749b90
+    ```
+
+2. Make sure the Go binary path is on your `PATH` and takes precedence over any existing `c8y` installation
+
+    ```sh
+    export PATH="$(go env GOPATH)/bin:$PATH"
+    hash -r
+    ```
+
+3. Verify the binary is the expected version
+
+    ```sh
+    c8y version
+    ```
+
+4. Try it out (note: tab completion won't work when using the `set-session` helper)
+
+    ```sh
+    # Option 1: Use an explicit host (no session file required)
+    eval "$(c8y sessions login --from-prompt --host example.cumulocity.com)"
+
+    # To enable verbose/debug output, add the -v flag
+    c8y currentuser get -v
+    ```
+
+### Uninstall
+
+To remove the dev binary and restore the previously installed version:
+
+```sh
+rm "$(go env GOPATH)/bin/c8y"
+hash -r
+```
+
 ## Documentation
 
 See the [documentation website](https://goc8ycli.netlify.app/) for instructions on how to install and use it.

docs/go-c8y-cli/docs/cli/c8y/alarms/assert/c8y_alarms_assert_count.md

@@ -40,6 +40,7 @@ $ c8y devices list | c8y alarms assert count --maximum 0 --dateFrom -7d
 ### Options
 
 ```
+      --attempts int          Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --dateFrom string       Start date or date and time of alarm occurrence.
       --dateTo string         End date or date and time of alarm occurrence.
       --device strings        The ManagedObject which is the source of this event. (accepts pipeline)
@@ -50,7 +51,6 @@ $ c8y devices list | c8y alarms assert count --maximum 0 --dateFrom -7d
       --maximum int           Maximum alarm count (inclusive). A value of -1 will disable this check (default -1)
       --minimum int           Minimum alarm count (inclusive). A value of -1 will disable this check (default -1)
       --resolved              When set to true only resolved alarms will be removed (the one with status CLEARED), false means alarms with status ACTIVE or ACKNOWLEDGED.
-      --retries int           Number of retries before giving up per id
       --severity string       Alarm severity, for example CRITICAL, MAJOR, MINOR or WARNING.
       --status string         Comma separated alarm statuses, for example ACTIVE,CLEARED.
       --strict                Strict mode, fail if no match is found
@@ -99,6 +99,7 @@ $ c8y devices list | c8y alarms assert count --maximum 0 --dateFrom -7d
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/devices/assert/c8y_devices_assert_exists.md

@@ -42,12 +42,12 @@ $ echo 1 | c8y devices assert exists --strict
 ### Options
 
 ```
+      --attempts int      Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --device strings    The ManagedObject which is the source of this event. (accepts pipeline)
       --duration string   Timeout duration. i.e. 30s or 1m (1 minute) (default "30s")
   -h, --help              help for exists
       --interval string   Interval to check on the status, i.e. 10s or 1min (default "5s")
       --not               Negate the match
-      --retries int       Number of retries before giving up per id
       --strict            Strict mode, fail if no match is found
 ```
 
@@ -93,6 +93,7 @@ $ echo 1 | c8y devices assert exists --strict
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/devices/assert/c8y_devices_assert_fragments.md

@@ -38,12 +38,12 @@ $ c8y devices list --device 1111 | c8y operations fragments --status "FAILED" --
 ### Options
 
 ```
+      --attempts int        Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --device strings      The ManagedObject which is the source of this event. (accepts pipeline)
       --duration string     Timeout duration. i.e. 30s or 1m (1 minute) (default "30s")
       --fragments strings   Fragments to fragments for. If multiple values are given, then it will be applied as an OR operation
   -h, --help                help for fragments
       --interval string     Interval to check on the status, i.e. 10s or 1min (default "5s")
-      --retries int         Number of retries before giving up per id
       --strict              Strict mode, fail if no match is found
 ```
 
@@ -89,6 +89,7 @@ $ c8y devices list --device 1111 | c8y operations fragments --status "FAILED" --
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/events/assert/c8y_events_assert_count.md

@@ -40,6 +40,7 @@ $ c8y devices list | c8y events assert count --maximum 0 --dateFrom -7d
 ### Options
 
 ```
+      --attempts int          Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --dateFrom string       Start date or date and time of event occurrence.
       --dateTo string         End date or date and time of event occurrence.
       --device strings        The ManagedObject which is the source of this event. (accepts pipeline)
@@ -49,7 +50,6 @@ $ c8y devices list | c8y events assert count --maximum 0 --dateFrom -7d
       --interval string       Interval to check on the status, i.e. 10s or 1min (default "5s")
       --maximum int           Maximum event count (inclusive). A value of -1 will disable this check (default -1)
       --minimum int           Minimum event count (inclusive). A value of -1 will disable this check (default -1)
-      --retries int           Number of retries before giving up per id
       --strict                Strict mode, fail if no match is found
       --type string           Event type.
 ```
@@ -96,6 +96,7 @@ $ c8y devices list | c8y events assert count --maximum 0 --dateFrom -7d
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/inventory/assert/c8y_inventory_assert_exists.md

@@ -42,12 +42,12 @@ $ echo 1 | c8y inventory assert exists --strict
 ### Options
 
 ```
+      --attempts int      Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --duration string   Timeout duration. i.e. 30s or 1m (1 minute) (default "30s")
   -h, --help              help for exists
       --id strings        Inventory id (required) (accepts pipeline)
       --interval string   Interval to check on the status, i.e. 10s or 1min (default "5s")
       --not               Negate the match
-      --retries int       Number of retries before giving up per id
       --strict            Strict mode, fail if no match is found
 ```
 
@@ -93,6 +93,7 @@ $ echo 1 | c8y inventory assert exists --strict
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/inventory/assert/c8y_inventory_assert_fragments.md

@@ -38,12 +38,12 @@ $ c8y inventory list --device 1111 | c8y operations fragments --status "FAILED"
 ### Options
 
 ```
+      --attempts int        Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --duration string     Timeout duration. i.e. 30s or 1m (1 minute) (default "30s")
       --fragments strings   Fragments to fragments for. If multiple values are given, then it will be applied as an OR operation
   -h, --help                help for fragments
       --id strings          Inventory id (required) (accepts pipeline)
       --interval string     Interval to check on the status, i.e. 10s or 1min (default "5s")
-      --retries int         Number of retries before giving up per id
       --strict              Strict mode, fail if no match is found
 ```
 
@@ -89,6 +89,7 @@ $ c8y inventory list --device 1111 | c8y operations fragments --status "FAILED"
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/measurements/assert/c8y_measurements_assert_count.md

@@ -40,6 +40,7 @@ $ c8y devices list | c8y measurements assert count --maximum 0 --dateFrom -7d
 ### Options
 
 ```
+      --attempts int                 Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --dateFrom string              Start date or date and time of measurement occurrence.
       --dateTo string                End date or date and time of measurement occurrence.
       --device strings               The ManagedObject which is the source of this event. (accepts pipeline)
@@ -48,7 +49,6 @@ $ c8y devices list | c8y measurements assert count --maximum 0 --dateFrom -7d
       --interval string              Interval to check on the status, i.e. 10s or 1min (default "5s")
       --maximum int                  Maximum measurement count (inclusive). A value of -1 will disable this check (default -1)
       --minimum int                  Minimum measurement count (inclusive). A value of -1 will disable this check (default -1)
-      --retries int                  Number of retries before giving up per id
       --strict                       Strict mode, fail if no match is found
       --type string                  Measurement type.
       --valueFragmentSeries string   value fragment series
@@ -97,6 +97,7 @@ $ c8y devices list | c8y measurements assert count --maximum 0 --dateFrom -7d
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/operations/assert/c8y_operations_assert_count.md

@@ -40,6 +40,7 @@ $ c8y devices list | c8y operations assert count --maximum 0 --dateFrom -7d
 ### Options
 
 ```
+      --attempts int             Number of attempts before giving up per id (-1 = unlimited) (default -1)
       --bulkOperationId string   Bulk operation id. Only retrieve operations related to the given bulk operation.
       --dateFrom string          Start date or date and time of operation.
       --dateTo string            End date or date and time of operation.
@@ -50,7 +51,6 @@ $ c8y devices list | c8y operations assert count --maximum 0 --dateFrom -7d
       --interval string          Interval to check on the status, i.e. 10s or 1min (default "5s")
       --maximum int              Maximum operation count (inclusive). A value of -1 will disable this check (default -1)
       --minimum int              Minimum operation count (inclusive). A value of -1 will disable this check (default -1)
-      --retries int              Number of retries before giving up per id
       --status string            Operation status, can be one of SUCCESSFUL, FAILED, EXECUTING or PENDING.
       --strict                   Strict mode, fail if no match is found
 ```
@@ -97,6 +97,7 @@ $ c8y devices list | c8y operations assert count --maximum 0 --dateFrom -7d
       --progress                   Show progress bar. This will also disable any other verbose output
       --proxy string               Proxy setting, i.e. http://10.0.0.1:8080
   -r, --raw                        Show raw response. This mode will force output=json and view=off
+      --retries int                Max number of attempts when a failed http call is encountered (default 3)
       --select stringArray         Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
       --session string             Session configuration
       --sessionMode string         Override default session mode for a single command which would normally be disabled

docs/go-c8y-cli/docs/cli/c8y/scripts/_category_.json

@@ -0,0 +1 @@
+{"key": "c8y-scripts", "label": "scripts"}