@twin.org/node 0.0.3-next.27 → 0.0.3-next.29

package/docs/{examples.md → usage.md}

@@ -1,34 +1,85 @@
-# Examples
+# Node Usage
 
-## CLI Usage
+These commands cover local installation, on demand execution, and a complete bootstrap flow that can be reused in deployment scripts.
 
-To run the command from the package either:
+## Running
 
-Install `@twin.org/node@next` and use the following command:
+To install and run the CLI locally use the following commands:
 
 ```shell
-twin-node --help
+npm install @twin.org/node -g
+twin-node
 ```
 
-or
+or run directly using NPX:
 
 ```shell
-npx "@twin.org/node@next" --help
+npx "@twin.org/node"
 ```
 
-### Display help listing all commands
+## Help
 
-```shell
-twin-node --help
+```text
+🌩️  TWIN Node v0.0.3-next.26
+
+Command: help
+
+All the commands available are listed below, for more information use the --help option with a specific command.
+bootstrap-legacy: Bootstrap in legacy mode for backwards compatibility, **will be deprecated in future versions**
+identity-create: Create an identity
+identity-import: Import an identity
+identity-verification-method-create: Create an identity verification method
+identity-verification-method-import: Import an identity verification method
+identity-verifiable-credential-create: Create a verifiable credential
+node-set-identity: Set the node identity
+node-set-tenant: Set the node tenant
+tenant-create: Create a tenant with associated api key
+tenant-import: Import a tenant with associated api key
+tenant-update: Update a tenant with associated api key
+user-create: Create a user
+user-update: Update a user
+vault-key-create: Create a vault key for an identity
+vault-key-import: Import a vault key for an identity
 ```
 
-### Display help for specific command
+## identity-create --help
 
-```shell
-twin-node command --help
+```text
+identity-create: Create an identity
+
+env-prefix: (string, optional)
+Prefix to use for standard .env files e.g. TWIN_.
+
+mnemonic: (string, 24 words, optional)
+The mnemonic phrase to use for the identity. If not provided, a random mnemonic will be generated.
+
+identity: (string, did, optional)
+The DID of the identity to create. If not provided, a new DID will be generated.
+
+controller: (string, did, optional)
+The controller DID for the identity. If not provided, the identity will be its own controller.
+
+fund-wallet: (boolean, default: 'false', optional)
+Whether to fund the wallet associated with the identity from a faucet.
+
+load-env: (string, optional)
+Comma separated list of paths to .env files to read input parameters from.
+
+output-json: (string, optional)
+Path to a .json file to store the command output.
+
+output-env: (string, optional)
+Path to a .env file to store the command output.
+
+output-env-prefix: (string, optional)
+Prefix to use for variables in the output .env file.
+
+Example: identity-create --mnemonic="..." --fund-wallet=true
 ```
 
-### Bootstrap legacy mode **will be deprecated in future versions**
+## Example
+
+### Bootstrap legacy mode will be deprecated in future versions
 
 ```shell
 twin-node bootstrap-legacy --load-env=".env.bootstrap-legacy"
@@ -40,7 +91,7 @@ twin-node bootstrap-legacy --load-env=".env.bootstrap-legacy"
 twin-node identity-create --fund-wallet=true --output-json="node-identity.json" --output-env="node-identity.env" --output-env-prefix=node
 ```
 
-Alternatively import existing details:
+### Import existing identity details
 
 ```shell
 twin-node identity-import --load-env="my-identity.env" --identity=!MY_DID --mnemonic=!MY_MNEMONIC
@@ -58,13 +109,13 @@ twin-node node-set-identity --load-env="node-identity.env" --identity=!NODE_DID
 twin-node vault-key-create --load-env="node-identity.env" --identity=!NODE_DID --key-id=!TWIN_AUTH_SIGNING_KEY_ID --output-json="node-auth-key.json" --output-env="node-auth-key.env"
 ```
 
-Alternatively import existing details:
+### Import existing authentication signing key details
 
 ```shell
 twin-node vault-key-import --load-env="node-identity.env,node-auth-key.json" --identity=!NODE_DID --key-id=!TWIN_AUTH_SIGNING_KEY_ID --key-type=!KEY_TYPE --private-key-hex=!PRIVATE_KEY_HEX
 ```
 
-### Add a key associated with the node identity for use by the synchronised storage blob encryption
+### Add a key associated with the node identity for use by synchronised storage blob encryption
 
 ```shell
 twin-node vault-key-create --load-env="node-identity.env" --identity=!NODE_DID --key-id=!TWIN_SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID --key-type=ChaCha20Poly1305 --output-json="node-synchronised-storage-encryption-key.json" --output-env="node-synchronised-storage-encryption-key.env"
@@ -76,7 +127,7 @@ twin-node vault-key-create --load-env="node-identity.env" --identity=!NODE_DID -
 twin-node vault-key-import --load-env="node-identity.env,my-key.json" --identity=!NODE_DID --key-id=!TWIN_AUTH_SIGNING_KEY_ID --key-type=!KEY_TYPE --private-key-hex=!PRIVATE_KEY_HEX
 ```
 
-Alternatively import existing details:
+### Create a tenant to be used by the node
 
 ```shell
 twin-node tenant-create --label="node" --public-origin="https://api.example.com" --output-env-prefix=node --output-json="node-tenant.json" --output-env="node-tenant.env"
@@ -94,25 +145,25 @@ twin-node tenant-import --load-env="node-tenant.json" --tenant-id=!NODE_TENANT_I
 twin-node tenant-update --load-env="node-tenant.json" --tenant-id=!NODE_TENANT_ID --label="New Label"
 ```
 
-### Associated the tenant with the node
+### Associate the tenant with the node
 
 ```shell
 twin-node node-set-tenant --load-env="node-tenant.env" --tenant-id=!NODE_TENANT_ID
 ```
 
-### Create an organization identity
+### Create an organisation identity
 
 ```shell
-twin-node identity-create --load-env="node-identity.env" --fund-wallet=true --output-json="organization-identity.json" --output-env="organization-identity.env"  --output-env-prefix=organization
+twin-node identity-create --load-env="node-identity.env" --fund-wallet=true --output-json="organization-identity.json" --output-env="organization-identity.env" --output-env-prefix=organization
 ```
 
-### Add a verification method to the organization identity for attestation
+### Add a verification method to the organisation identity for attestation
 
 ```shell
 twin-node identity-verification-method-create --load-env="node-identity.env,organization-identity.env" --identity=!ORGANIZATION_DID --controller=!NODE_DID --verification-method-id=!TWIN_ATTESTATION_VERIFICATION_METHOD_ID --output-json="organization-attestation.json" --output-env="organization-attestation.env"
 ```
 
-Alternatively import existing details:
+### Import an attestation verification method for the organisation identity
 
 ```shell
 twin-node identity-verification-method-import --load-env="node-identity.env,organization-identity.env,organization-attestation.env" --identity=!ORGANIZATION_DID --controller=!NODE_DID --verification-method-id=!DID_VERIFICATION_METHOD_ID --private-key-hex=!DID_VERIFICATION_METHOD_PRIVATE_KEY_HEX
@@ -124,25 +175,25 @@ twin-node identity-verification-method-import --load-env="node-identity.env,orga
 twin-node identity-verifiable-credential-create --load-env="organization-identity.env,organization-attestation.env" --identity=!ORGANIZATION_DID --verification-method-id=!TWIN_ATTESTATION_VERIFICATION_METHOD_ID --subject-json="subject.json" --output-json="organization-attestation-credential.json" --output-env="organization-attestation-credential.env"
 ```
 
-### Add a verification method to the organization identity for immutable proofs
+### Add a verification method to the organisation identity for immutable proofs
 
 ```shell
 twin-node identity-verification-method-create --load-env="node-identity.env,organization-identity.env" --identity=!ORGANIZATION_DID --controller=!NODE_DID --verification-method-id=!TWIN_IMMUTABLE_PROOF_VERIFICATION_METHOD_ID --output-json="organization-immutable-proof.json" --output-env="organization-immutable-proof.env"
 ```
 
-### Add a verification method to the organization identity for trust verification
+### Add a verification method to the organisation identity for trust verification
 
 ```shell
 twin-node identity-verification-method-create --load-env="node-identity.env,organization-identity.env" --identity=!ORGANIZATION_DID --controller=!NODE_DID --verification-method-id=!TWIN_TRUST_VERIFICATION_METHOD_ID --output-json="organization-trust.json" --output-env="organization-trust.env"
 ```
 
-### Add a key associated with the organization to be used for blob encryption
+### Add a key associated with the organisation to be used for blob encryption
 
 ```shell
 twin-node vault-key-create --load-env="organization-identity.env" --identity=!ORGANIZATION_DID --key-id=!TWIN_BLOB_STORAGE_ENCRYPTION_KEY_ID --key-type=ChaCha20Poly1305 --output-json="organization-blob-encryption.json" --output-env="organization-blob-encryption.env"
 ```
 
-### Create an identity associated with the organization
+### Create an identity associated with the organisation
 
 ```shell
 twin-node identity-create --load-env="organization-identity.env" --controller=!ORGANIZATION_DID --output-json="user-identity.json" --output-env="user-identity.env" --output-env-prefix=user

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node",
-	"version": "0.0.3-next.27",
+	"version": "0.0.3-next.29",
 	"description": "TWIN Node serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/node-core": "0.0.3-next.27"
+		"@twin.org/node-core": "0.0.3-next.29"
 	},
 	"bugs": {
 		"url": "git+https://github.com/twinfoundation/node/issues"