vigyl-cli
v0.1.3
Published
VIGYL command-line interface -- create jobs, run a bonded keeper daemon, simulate.
Downloads
108
Maintainers
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
npm install -g vigyl-cliQuick start
# 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 executionsFlags 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 100bonds 100 $VIGYL). Pass--base-unitsto give a raw base-unit amount instead, or--dry-runto 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
