# vigyl-cli

> VIGYL command-line interface -- create jobs, run a bonded keeper daemon, simulate.

Latest version **0.1.3** (published 2026-07-26) · Apache-2.0 license · 0 weekly downloads

## Install

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

Provides the command `vigyl`.

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2026-07-26 |
| First published | 2026-07-08 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 141.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | VIGYL Contributors |
| Maintainers | vigyl |
| Keywords | solana, automation, keeper, cron, vigyl |

## Links

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

## Dependencies (11)

- [ora](https://npm.io/package/ora.md) 8.1.0
- [pino](https://npm.io/package/pino.md) 9.3.2
- [bn.js](https://npm.io/package/bn.js.md) 5.2.1
- [chalk](https://npm.io/package/chalk.md) 5.3.0
- [prompts](https://npm.io/package/prompts.md) 2.4.2
- [commander](https://npm.io/package/commander.md) 12.1.0
- [pino-pretty](https://npm.io/package/pino-pretty.md) 11.2.2
- [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) 1.95.3
- [@coral-xyz/anchor](https://npm.io/package/@coral-xyz/anchor.md) 0.31.0
- [@pythnetwork/hermes-client](https://npm.io/package/@pythnetwork/hermes-client.md) 1.2.0
- [@pythnetwork/pyth-solana-receiver](https://npm.io/package/@pythnetwork/pyth-solana-receiver.md) 0.9.0

## Recent versions

- 0.1.3 (latest) — 2026-07-26
- 0.1.2 — 2026-07-26
- 0.1.1 — 2026-07-19
- 0.1.0 — 2026-07-08

## README

# vigyl-cli

Command-line interface for VIGYL, the Solana keeper network. Create automation
jobs, run a bonded keeper daemon, simulate a job spec, and read the keeper
leaderboard.

The VIGYL Anchor IDL is bundled with this package, so no local Anchor build is
required.

## Install

```sh
npm install -g vigyl-cli
```

## Quick start

```sh
# Write ~/.config/vigyl/config.json
vigyl init \
  --rpc-url https://api.devnet.solana.com \
  --program-id <VIGYL_PROGRAM_ID> \
  --wallet ~/.config/solana/id.json \
  --yes

vigyl job list          # jobs registered on the program
vigyl leaderboard       # top keepers by executions
```

Flags passed to `init` are honored (both `vigyl init --rpc-url ...` and
`vigyl --rpc-url ... init` work). Without `--yes`, `init` prompts interactively.

## Configuration

Resolution order for every setting is: command flag, then environment variable,
then `~/.config/vigyl/config.json`, then the built-in default.

| Setting     | Flag             | Env                | Default                              |
| ----------- | ---------------- | ------------------ | ------------------------------------ |
| RPC URL     | `--rpc-url`      | `VIGYL_RPC_URL`    | `https://api.mainnet-beta.solana.com`|
| Program id  | `--program-id`   | `VIGYL_PROGRAM_ID` | (unset)                              |
| Wallet path | `--wallet`       | `SOLANA_WALLET`    | `~/.config/solana/id.json`           |
| Config path | `--config`       | -                  | `~/.config/vigyl/config.json`        |

`VIGYL_IDL_PATH` overrides the bundled IDL if you need a custom build.

## Commands

- `vigyl init` - write the local config.
- `vigyl job create` - register a job from flags or `--spec <job-spec.json>`.
- `vigyl job list [--owner <pubkey>]` - list jobs.
- `vigyl job pause|resume|cancel <job>` / `vigyl job fund <job> <sol>`.
- `vigyl simulate <spec>` - simulate a job spec (no on-chain write). The keeper
  wallet is used as the fee payer, so specs with no target accounts simulate
  cleanly.
- `vigyl keeper bond <amount>` - deposit a $VIGYL bond. `<amount>` is in $VIGYL
  (e.g. `vigyl keeper bond 100` bonds 100 $VIGYL). Pass `--base-units` to give a
  raw base-unit amount instead, or `--dry-run` to print the resolved base-unit
  amount without sending a transaction.
- `vigyl keeper run` - run the bonded keeper daemon. The bond gate reports the
  minimum in human units, e.g. `min 100 $VIGYL`.
- `vigyl keeper unbond|withdraw`.
- `vigyl leaderboard [--limit <n>]`.

## License

Apache-2.0

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