Add instructions to run CLI tests #58

Merged
nabarun merged 3 commits from deep-stack/laconic-registry-cli:nv-update-readme into laconic2 2024-03-21 11:19:15 +00:00
2 changed files with 34 additions and 0 deletions
Showing only changes of commit cd52a9ae93 - Show all commits

View File

@ -2,6 +2,28 @@
CLI utility written in TS, used to interact with laconicd. Depends on [registry-sdk](https://git.vdb.to/cerc-io/registry-sdk). CLI utility written in TS, used to interact with laconicd. Depends on [registry-sdk](https://git.vdb.to/cerc-io/registry-sdk).
## Install
- Add `.npmrc` file in desired project to resolve package
```bash
@cerc-io:registry=https://git.vdb.to/api/packages/cerc-io/npm/
```
This will set the registry for `cerc-io` scoped packages in the project
- Install the CLI using package manager
```bash
yarn add @cerc-io/laconic-registry-cli
```
- For installing CLI globally add `.npmrc` file above in home directory and run
```bash
yarn global add @cerc-io/laconic-registry-cli
```
## Setup ## Setup
* Run `yarn` to install all dependencies. * Run `yarn` to install all dependencies.
@ -10,6 +32,12 @@ CLI utility written in TS, used to interact with laconicd. Depends on [registry-
* Create a `config.yml` file from [config.example.yml](./config.example.yml) file. * Create a `config.yml` file from [config.example.yml](./config.example.yml) file.
* Add CLI cmd to path
```bash
export PATH="$PWD/bin:$PATH"
```
## Account Setup ## Account Setup
Run the chain: Run the chain:

View File

@ -2,6 +2,12 @@
* Follow the project `Setup` and `Account Setup` from root [README](./../README.md) * Follow the project `Setup` and `Account Setup` from root [README](./../README.md)
* Add laconic cmd to path
```bash
export PATH="$PWD/bin:$PATH"
```
* Create a .env file using [.env.example](./.env.example): * Create a .env file using [.env.example](./.env.example):
```bash ```bash