Catalyst Package Manager - CLI User Guide

In this section we will guide you on how to use Catalyst Package Manager (CPM).

Login

To generate an access-token that allows you to identify yourself in the CPM CLI tool, please insert the following command:

$ cpm login

When executing this command, a new tab will open on your browser requiring you to log in to the Keycloak page.

The token is then provided on your terminal window.

Store your access token as it will be needed for most commands.

Discover

List apps published on CPM

To display a list of the applications available on the CPM registry, please insert the following command:

$ cpm list
List apps
Figure 1. List apps

If instead the user wants to see the list of applications published by a specific App-Builder, type in:

$ cpm list <PUBLISHER>

Where:

  • <PUBLISHER> is the Identifier of the App-Builder.

List apps by publisher
Figure 2. List apps by publisher

List accesses

To see all the accessible artifacts, insert the following command:

$ cpm --access-token <ACCESS_TOKEN> list-accesses

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

List accesses
Figure 3. List accesses

Request access to an app

In case a user has no permissions to download an app, they can request it by executing the following command:

$ cpm --access-token <ACCESS_TOKEN> request-access <ARTIFACT_CONTRACT_ID> <CUSTOMER>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <ARTIFACT_CONTRACT_ID> is the contract ID of the artifact

  • <CUSTOMER> is the party for whom you want to request access.

Request access
Figure 4. Request access

Cancel access request

To cancel an access request type in the following command:

$ cpm --access-token <ACCESS_TOKEN> cancel-access-request <ACCESS_REQUEST_CONTRACT_ID>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <ACCESS_REQUEST_CONTRACT_ID> is the contract ID that identifies the access request.

Download an app from the CPM Registry

When the user has been granted with permissions to download an app, they can the necessary resources by executing the following command:

$ cpm --access-token <ACCESS_TOKEN> download <ACCESS_CONTRACT_ID > <OUTPUT_FILE>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <ACCESS_CONTRACT_ID> is the contract ID of the artifat access

  • <OUTPUT_FILE> is the name of the file created.

Publish

Publish an app on the CPM Registry

App Builders can publish an app on the CPM Registry.

This can be done by executing the following command:

$ cpm --access-token <ACCESS_TOKEN> publish <PUBLISHER> <HASH> <NAME> <VERSION> <LISTER>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <PUBLISHER> is the publisher of the artifact

  • <HASH> is the hash of the artifact

  • <NAME> is the name of the artifact

  • <VERSION> is the version of the artifact

  • <LISTER> is the ID of the Lister.

List access requests

To see all the visible access requests type in the following command:

$ cpm --access-token <ACCESS_TOKEN> list-access-requests

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

List access request
Figure 5. List access requests

Approve or reject access requests

To approve or reject a permissions request, type in the corresponding command:

$ cpm --access-token <ACCESS_TOKEN> approve-access-request <ACCESS_REQUEST_CONTRACT_ID> <URL>
$ cpm --access-token <ACCESS_TOKEN> reject-access-request <ACCESS_REQUEST_CONTRACT_ID>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <ACCESS_REQUEST_CONTRACT_ID> is the contract ID of the access request

  • <URL> is the URL to the app.

Approve access request
Figure 6. Approve access request

Unpublish an app from the CPM Registry

To unpublish an app previously published by the same user on the CPM registry, insert the following command:

$ cpm --access-token <ACCESS_TOKEN> unpublish <ARTIFACT_CONTRACT_ID>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <ARTIFACT_CONTRACT_ID> is the contract ID of the artifact.

Audit

Request audit

App builders can at any time request any other Participant of the Canton network to audit their application. To do so, execute the following command:

$ cpm --access-token <ACCESS_TOKEN> request-audit <ARTIFACT_CONTRACT_ID> <AUDITOR> <URL>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <ARTIFACT_CONTRACT_ID> is the contract ID of the artifact

  • <AUDITOR> is the party from whom you want to request the audit

  • <URL> is the URL for the auditor to download the artifact

Request audit
Figure 7. Request audit

Cancel audit request

To cancel a previous audit request, execute the following command:

$ cpm --access-token <ACCESS_TOKEN> cancel-audit-request <AUDIT_REQUEST_CONTRACT_ID>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <AUDIT_REQUEST_CONTRACT_ID> is the contract ID of the audit request

List audit requests

To see all the Audit requests, type in the following command:

$ cpm  --access-token <ACCESS_TOKEN> list-audit-requests

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

List audit requests
Figure 8. List audit requests

Approve or reject an audit request

As an Auditor, if you want to approve or reject an audit request, type in the corresponding command:

$ cpm  --access-token <ACCESS_TOKEN> approve-audit-request <AUDIT_REQUEST_CONTRACT_ID>
$ cpm  --access-token <ACCESS_TOKEN> reject-audit-requests <AUDIT_REQUEST_CONTRACT_ID>

Where:

  • <ACCESS_TOKEN> is the access token returned after the user logged in.

  • <AUDIT_REQUEST_CONTRACT_ID> is the contract ID of the audit request.

Approve audit requests
Figure 9. Approve audit requests

Help

To see a help menu please type in the following command:

$ cpm  --help
CPM Help
Figure 10. CPM help

If instead you need help with a specific command, type in:

$ cpm  <COMMAND> --help

Where:

  • <COMMAND> is the command that you want help with.

CPM Help with a command
Figure 11. CPM help with a command