# mina-maya

> CLI tool for interacting with Mina ecosystem

Latest version **0.0.6** (published 2024-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install mina-maya
pnpm add mina-maya
yarn add mina-maya
bun add mina-maya
```

Provides the command `mina-maya`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2024-01-12 |
| First published | 2023-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 16.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Philosakha |
| Maintainers | saviour1001 |
| Keywords | mina, maya, mina-maya, blockchain |

## Links

- npm: https://www.npmjs.com/package/mina-maya
- Repository: https://github.com/Philosakha/mina-cli
- Homepage: https://github.com/Philosakha/mina-cli#readme
- Issues: https://github.com/Philosakha/mina-cli/issues
- npm.io page: https://npm.io/package/mina-maya

## Dependencies (9)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [figlet](https://npm.io/package/figlet.md) ^1.7.0
- [ts-node](https://npm.io/package/ts-node.md) ^10.9.2
- [inquirer](https://npm.io/package/inquirer.md) ^9.2.12
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.11
- [loading-cli](https://npm.io/package/loading-cli.md) ^1.1.2
- [child_process](https://npm.io/package/child_process.md) ^1.0.2
- [chalk-animation](https://npm.io/package/chalk-animation.md) ^2.0.3

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2024-01-12
- 0.0.5 — 2023-11-23
- 0.0.4 — 2023-11-13
- 0.0.3 — 2023-11-13
- 0.0.2 — 2023-11-04
- 0.0.1 — 2023-11-04

## README

# Maya-cli

The Maya CLI is a versatile utility designed to simplify common tasks related to the Mina blockchain project. With this tool, you can perform various operations, including:

## Features:

### 1. Create Frontend

- **Description**: Quickly set up a frontend for your Mina project using popular frameworks like Next.js and React.js.
- **Usage**:
  ```bash
  npx mina-maya create-frontend
  ```

### 2. Check Balance

- **Description**: Retrieve the balance associated with a specific Mina account using the Mina Explorer API.
- **Usage**:
  ```bash
  npx mina-maya check-balance
  ```

### 3. Check Mina

- **Description**: Obtain essential data about the Mina blockchain network, such as blockchain length, circulating supply, state hash, chain ID, and total currency.
- **Usage**:

  ```bash
  npx mina-maya check-mina
  ```

- **Example Output**:

  ```bash
  Metric           Value
  ---------------  ------------------------------------
  Blockchain       1,000,000
  Circulating      1,000,000
  State Hash       3NLES4Ho75Pv7DRCbNPUpjyzGCC4M69ssoeUsVJgnqoR4DR7v2du
  Chain id         5f704cc0c82e0ed70e873f0893d7e06f148524e3f0bdae2afb02e7819a0c24d1
  Total currency   1107082252.840039233
  ```

## Prerequisites:

Before using the Mina Project Command-Line Tool, ensure that you have the following prerequisites installed on your system:

- Node.js: [Node.js Installation Guide](https://nodejs.org/)

## Getting Started:

1. Clone the project repository or download the script.

2. Install project dependencies by running the following command in the project's directory:

   ```bash
   yarn install
   ```

3. Run the script using the following command:

   ```bash
   yarn start <operation>
   ```

4. For building the script, run the following command:

   ```bash
   yarn build
   ```

   The script will be built in the `dist` directory.

## Usage:

To use the tool, run it with one of the specified operations as an argument. For example, to create the frontend, run:

```bash
npx mina-maya create-frontend
```

Replace `npx mina-maya` with the path to the script if needed.

If you specify an invalid operation, the script will display a list of available operations.

## Acknowledgments:

This project utilizes third-party libraries to enhance functionality:

- [chalk](https://www.npmjs.com/package/chalk) for colorful console output.
- [inquirer](https://www.npmjs.com/package/inquirer) for interactive command-line prompts.

## License:

This project is licensed under the MIT License.

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