# damlhub-cli

> A CLI for managing Daml Hub deployments

Latest version **0.0.1-alpha.20** (published 2024-03-19) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install damlhub-cli
pnpm add damlhub-cli
yarn add damlhub-cli
bun add damlhub-cli
```

Provides the command `damlhub`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.20 |
| Published | 2024-03-19 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Digital Asset |
| Maintainers | alexmatson-da, sammy-da, sarahbreckenridge, alexgraham-da |

## Links

- npm: https://www.npmjs.com/package/damlhub-cli
- Homepage: https://hub.daml.com
- npm.io page: https://npm.io/package/damlhub-cli

## Dependencies (15)

- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [nconf](https://npm.io/package/nconf.md) ^0.12.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [semver](https://npm.io/package/semver.md) >=7.5.2
- [node-jq](https://npm.io/package/node-jq.md) ^2.3.5
- [commander](https://npm.io/package/commander.md) ^8.0.0
- [cli-table3](https://npm.io/package/cli-table3.md) ^0.6.0
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.0.6
- [follow-redirects](https://npm.io/package/follow-redirects.md) ^1.13.1
- [node-localstorage](https://npm.io/package/node-localstorage.md) ^2.2.1
- [typescript-logging](https://npm.io/package/typescript-logging.md) ^2.0.2
- [typescript-logging-log4ts-style](https://npm.io/package/typescript-logging-log4ts-style.md) ^2.0.2

## Recent versions

- 0.0.1-alpha.20 (latest) — 2024-03-19
- 0.0.1-alpha.19 — 2024-01-30
- 0.0.1-alpha.18 — 2023-10-31
- 0.0.1-alpha.17 — 2023-10-10
- 0.0.1-alpha.16 — 2023-08-28
- 0.0.1-alpha.15 — 2023-07-12
- 0.0.1-alpha.14 — 2023-04-26
- 0.0.1-alpha.13 — 2023-04-21
- 0.0.1-alpha.12 — 2023-01-06
- 0.0.1-alpha.11 — 2022-10-06
- 0.0.1-alpha.10 — 2022-10-04
- 0.0.1-alpha.9 — 2022-08-22
- 0.0.1-alpha.8 — 2022-07-19
- 0.0.1-alpha.7 — 2022-05-13
- 0.0.1-alpha.5 — 2022-01-26
- … 3 more at https://npm.io/package/damlhub-cli/versions

## README

# damlhub-cli

## Installation

`npm install damlhub-cli`

## Common commands

| Action                | Command                                                         |
| --------------------- | --------------------------------------------------------------- |
| Set Token             | `damlhub token` **`ACCOUNT_JWT`**                               |
| Retrieve Token        | `damlhub token -r`                                              |
| Create New Project    | `damlhub project create` **`PROJECT_NAME`**                     |
| Add file to workspace | `damlhub workspace upload` **`FILE_NAME`**                      |
| Upload deployment     | `damlhub workspace deploy` **`LEDGER_ID FILE_NAME`**            |
| Start deployment      | `damlhub workspace install` **`LEDGER_ID`** **`ARTIFACT_HASH`** |

## Example script use:

### (e.g. where assets are readied for deployment in deploy/ and the ledger name is the first parameter to the script. _Note use of -j flag_ to enable retrieval of ids for subsequent command input)

     # List the workspace, if our token is not up to date this will fail.
     damlhub workspace ls  > /dev/null

     PROJECT_NAME=PROJECT1

     PROJECT_ID=`damlhub -j project ensure ${PROJECT_NAME} | jq -r '.id'`

     LEDGER_ID=`damlhub -j ledger create ${PROJECT_ID} $1 | jq -r '.id'`

     echo $LEDGER_ID

     for name in PartyA PartyB PartyC
     do
       damlhub -j ledger party ${LEDGER_ID} $name > /dev/null
     done

     for file in `ls deploy/ | grep -E '\.dar|\.zip'`
     do
       damlhub -j workspace upload deploy/$file
       FILE_HASH=`damlhub -j workspace deploy ${file} ${LEDGER_ID} fileHash | jq -r .`
       damlhub ledger deployDar $FILE_HASH $LEDGER_ID
     done

## Run locally

install dependencies via `npm install`,
and run via:

     npm run local -- <ARGS TO THE CLI>

---
_Source: https://npm.io/package/damlhub-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._