ethernaut-cli

ethernaut-cli copied to clipboard

What is it?

A universal Ethereum swiss army knife with an AI duck taped onto it.

A CLI for non-technical users, trying to bridge the gap between graphical UIs and CLIs.

A framework for rapid tool building; integrate a new tool in a matter of hours.

An extensible framework composed of hardhat plugins.

Example usages:

ethernaut what is the total supply of USDC

or

ethernaut complete level 2 of the ethernaut challenges

It can also be used as a regular cli:

ethernaut util unit 5 --from ether --to wei

And also features an interactive mode that allows easy navigation of tasks and collection of task arguments.

Installation

This CLI is mean to be installed globally, and not as a per-project task runner as hardhat is normally used for.

npm i -g ethernaut-cli

Additional requirements:

Anvil

curl -L https://foundry.paradigm.xyz | bash

foundryup

Development

This is a monorepo built with lerna, composed of hardhat plugins. The global nodejs application entry point is in packages/ethernaut-cli/ethernaut. All code is vanilla javascript.

Setup

Clone the repo.

Installs all monorepo dependencies.

npm install

Bootstraps lerna and runs build scripts for all packages.

npm run build

Compiles any contracts in the monorepo's packages.

npm run compile

Running

Use the global ethernaut binary to run the CLI.

./packages/ethernaut-cli/ethernaut <command> <args>

You may want to add this binary to your PATH in your .zshrc or .bashrc, so that you can run it with an abbreviation such as 'eth'.

eth <command> <args>

This would allow you to have an eth develpment version as well as an ethernaut official version installed on your system as a global npm package.

To run the CLI with verbose output, run:

DEBUG=* eth <command> <args> // All packages

DEBUG=*hardhat* eth <command> <args> // Hardhat packages

DEBUG=*ethernaut* eth <command> <args> // ethernaut packages

DEBUG=*ethernaut:ui* eth <command> <args> // ethernaut-ui packages

Testing

Some tests require a network to be running. You can start one with:

npm run chain

Tests all packages in the monorepo.

npm run test

To test a single package, run:

cd packages/ethernaut-ai && npm test

To run tests with verbose output, run:

DEBUG=* npm test // All packages

DEBUG=*hardhat* npm test // Hardhat packages

DEBUG=*ethernaut* npm test // ethernaut packages

DEBUG=*ethernaut:ui* npm test // ethernaut-ui packages

Tutorials and articles

• Announcing the ethernaut-cli

Features

Intuitive navigation

No more man pages. No more --help.

Just type ethernaut and jump straight into an enquirer based navigation mode. Select a scope, select a task, and boom.

Navigation demo

Smart interactive mode

Once in a task, interactive mode kicks in, and parameters are collected through enquirer prompts.

Enquirer param collection

Normal CLI interaction

This is still a regular CLI app, so commands can be called without all the fancy ui or ai stuff:

Normal CLI mode

Ui extensions

Plugins of plugins? Why not.

Plugins that enhance parameter collection prompts in other plugins with even cooler prompts, smart suggestions, etc.

For example, the ui extension of the interact plugin can fetch the abi from Etherscan if you didn't provide an abi:

Custom ABI Prompt

But after you've interacted with the contract, it already has the abi, so the abi is instead suggested:

Abi suggestion

Another example is the extension for the model param in ethernaut ai config --model, which queries the openai API and presents a list of available models.

Natural language to cli commands

If that wasn't easy enough, just type whatever you want and AI will kick in to try to make sense of what you typed, and the right command or sequence of commands will be executed.

Ai natural language interpretation

You want the AI to also teach you how the commands work? Sure.

Ai command explanation

You want the AI to also teach you about Ethereum. Also sure.

Complete level 1

Extensibility through hardhat plugins

You don't have to use this entire plethora of features tho. You can use a single feature in your regular hardhat project with exactly what you need. This is because the ethernaut-cli is completely built with hardhat plugins.

You just want task navigation and interactive mode in your project: use the ethernaut-ui plugin.

Or the ai stuff: use ethernaut-ai plugin.

All the plugins combined conform the ethernaut-cli.