package
This section lists the Corda CLI
A command line tool that supports various Corda-related tasks, including Corda Package Installer (CPI) creation and Corda cluster management.
package arguments. You can use these commands to execute operations for working with CPB
Corda Package Bundle. A signed ZIP/JAR collection of CPKs that forms a complete application suite and contains all the code that a virtual node must operate, minus the specific network details.
and CPI
Corda Package Installer. A signed ZIP/JAR combination of a CPB and a Group Policy File that defines not only the application code that a virtual node will run, but also the details of the MGM with which to register, and the details of network PKI requirements.
files, as described in the Packaging section for CorDapp Developers.
| Argument | Description |
|---|---|
| --create-cpb | Creates a CPB file. See create-cpb. |
| --create-cpi | Creates a CPI file. See create-cpi. |
create-cpb
The create-cpb argument creates a CPB file from a set of CPK
Corda Package. A signed ZIP/JAR library of Java code packaged to be portable with all of its dependencies and version information contained within it.
files using the following arguments:
| Argument | Description |
|---|---|
| --cpb-name | Specifies a name for the CPB. |
| --cpb-version | Specifies the CPB version. |
| --file | Specifies the name of the CPB file to create. |
| --keystore | Specifies the keystore file used to sign the file. |
| --storepass | Specifies the password for the keystore. |
| --key | Specifies the name of the key. |
For example:
./corda-cli.sh package create-cpb \
mycpk0.cpk mycpk1.cpk \
--cpb-name manifest-attribute-cpb-name \
--cpb-version manifest-attribute-cpb-version \
--file output.cpb \
--keystore signingkeys.pfx \
--storepass "keystore password" \
--key "signing key 1"
./corda-cli.cmd package create-cpb `
mycpk0.cpk mycpk1.cpk `
--cpb-name manifest-attribute-cpb-name `
--cpb-version manifest-attribute-cpb-version `
--file output.cpb `
--keystore signingkeys.pfx `
--storepass "keystore password" `
--key "signing key 1"
create-cpi
The create-cpi argument creates a CPI file using the following arguments:
| Argument | Description |
|---|---|
| --cpb | Specifies the CPB file to include in the CPI. This can be omitted when creating an MGM CPI. |
| --group-policy | Specifies the group policy A JSON file containing network information that is bundled with a CPB to create a CPI. file to include in the CPI. |
| --cpi-name | Specifies a name for the CPI. |
| --cpi-version | Specifies the CPI version. |
| --file | Specifies the name of the CPI file to create. |
| --keystore | Specifies the keystore file used to sign the file. |
| --storepass | Specifies the password for the keystore. |
| --key | Specifies the name of the key. |
For example:
./corda-cli.sh package create-cpi \
--cpb mycpb.cpb \
--group-policy TestGroupPolicy.json \
--cpi-name "cpi name" \
--cpi-version "1.0.0.0-SNAPSHOT" \
--file output.cpi \
--keystore signingkeys.pfx \
--storepass "keystore password" \
--key "signing key 1"
./corda-cli.cmd package create-cpi `
--cpb mycpb.cpb `
--group-policy TestGroupPolicy.json `
--cpi-name "cpi name" `
--cpi-version "1.0.0.0-SNAPSHOT" `
--file output.cpi `
--keystore signingkeys.pfx `
--storepass "keystore password" `
--key "signing key 1"
Was this page helpful?
Thanks for your feedback!
Chat with us
Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.
Propose documentation improvements directly
Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.
We're sorry this page wasn't helpful. Let us know how we can make it better!
Chat with us
Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.
Create an issue
Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.
Propose documentation improvements directly
Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.