# xrpld-cli

> ## Global Usage (For using as a cli)

Latest version **1.0.12** (published 2023-11-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `xrpld-cli`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2023-11-08 |
| First published | 2023-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 75.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Denis Angell |
| Maintainers | transia |

## Links

- npm: https://www.npmjs.com/package/xrpld-cli
- npm.io page: https://npm.io/package/xrpld-cli

## Dependencies (7)

- [pako](https://npm.io/package/pako.md) ^2.1.0
- [axios](https://npm.io/package/axios.md) ^1.3.4
- [dotenv](https://npm.io/package/dotenv.md) ^16.1.4
- [base64-js](https://npm.io/package/base64-js.md) ^1.5.1
- [commander](https://npm.io/package/commander.md) ^10.0.1
- [uninstall](https://npm.io/package/uninstall.md) ^0.0.0
- [xrpld-cli](https://npm.io/package/xrpld-cli.md) ^1.0.7

## Recent versions

- 1.0.12 (latest) — 2023-11-08
- 1.0.11 — 2023-11-08
- 1.0.10 — 2023-11-05
- 1.0.9 — 2023-10-04
- 1.0.8 — 2023-10-04
- 1.0.7 — 2023-09-25
- 1.0.6 — 2023-08-05
- 1.0.5 — 2023-07-13
- 1.0.4 — 2023-06-30
- 1.0.2 — 2023-06-29
- 1.0.1 — 2023-06-29

## README

# XRPLD-Cli

## Global Usage (For using as a cli)

Install:

`npm i -g xrpld-cli`

Use:

`xrpld-cli up`

### Starting the Development Environment

To start the development environment, you can use the following commands:

### Local Up

```shell
xrpld-cli up
```

### Debugging the Development Environment

To debug the Development Environment and monitor the execution of hooks, you can use the following command:

```shell
xrpld-cli trace
```

This command will run the `tail -f debug.log | grep HookTrace` stream the debug logs in real-time and filter for lines containing "HookTrace". It allows you to monitor the execution of hooks and identify any issues or errors.

As you interact with the XRPL or trigger hooks, you will see the corresponding debug log entries in the terminal. This can help you troubleshoot and debug any unexpected behavior or errors related to the execution of hooks.

To stop streaming the debug logs, press `Ctrl + C` in the terminal.

Using the `tail -f debug.log | grep HookTrace` command provides a convenient way to monitor the execution of hooks and debug the Development Environment.

### Xrpld Down

```shell
xrpld-cli down
```

The `xrpld down` command will stop and remove the Docker containers defined in the `docker-compose.yml` file. The `--remove-orphans` flag ensures that any orphaned containers are also removed.

### Xrpld Down with Container Removal

```shell
xrpld-cli down:clean
```

The `xrpld down:clean` command will stop and remove the Docker containers defined in the `docker-compose.yml` file, as well as any orphaned containers. It will also remove all the contents from the db and debug log folders. 

## Development / Deployment

### Build Repo

`yarn run build`

### Build Executable Package

`pkg .`

### Publish NPM Package

`npm publish`

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