Skip to content

Updates readme #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raiseerco merged 1 commit into from
Apr 26, 2025
Merged

Updates readme #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ It can also be used as a regular cli:

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

## Installation
### Prerequisites:

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

`npm i -g ethernaut-cli`
`curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -`

### Additional requirements:
`sudo apt install nodejs`

Anvil

Expand Down Expand Up @@ -206,21 +206,21 @@ All the plugins combined conform the ethernaut-cli.

<summary>List of packages</summary>

| Title | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [ethernaut-ai](packages/ethernaut-ai/README.md) | AI assistant that interprets user input and executes hardhat tasks |
| [ethernaut-ai-ui](packages/ethernaut-ai-ui/README.md) | Ui extensions for the ethernaut-ai package |
| [ethernaut-cli](packages/ethernaut-cli/README.md) | Main hardhat project |
| [ethernaut-challenges](packages/ethernaut-challenges/README.md) | Tasks for playing the Open Zeppelin Ethernaut challenges from the CLI |
| [ethernaut-common](packages/ethernaut-common/README.md) | Common utils used by several ethernaut-cli plugins |
| [ethernaut-interact](packages/ethernaut-interact/README.md) | Tasks for sending transactions and interacting with contracts |
| [ethernaut-interact-ui](packages/ethernaut-interact-ui/README.md) | Ui extensions for the ethernaut-interact package |
| [ethernaut-network](packages/ethernaut-network/README.md) | Tasks for interacting with different networks |
| [ethernaut-network-ui](packages/ethernaut-network-ui/README.md) | Ui extensions for the ethernaut-network package |
| [ethernaut-ui](packages/ethernaut-ui/README.md) | Intuitive navigation and interactive param collection for hardhat tasks |
| [ethernaut-util](packages/ethernaut-util/README.md) | Simple, everyday utilities for Ethereum devs |
| [ethernaut-util-ui](packages/ethernaut-util-ui/README.md) | Ui extensions for the ethernaut-util package |
| [ethernaut-wallet](packages/ethernaut-wallet/README.md) | Tasks for interacting from different Ethereum accounts |
| [ethernaut-wallet-ui](packages/ethernaut-wallet-ui/README.md) | Ui extensions for the ethernaut-wallet package |
| Title | Description |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [ethernaut-ai](packages/ethernaut-ai/README.md) | AI assistant that interprets user input and executes hardhat tasks and talks to Optimism documentation |
| [ethernaut-ai-ui](packages/ethernaut-ai-ui/README.md) | Ui extensions for the ethernaut-ai package |
| [ethernaut-cli](packages/ethernaut-cli/README.md) | Main hardhat project |
| [ethernaut-challenges](packages/ethernaut-challenges/README.md) | Tasks for playing the Open Zeppelin Ethernaut challenges from the CLI |
| [ethernaut-common](packages/ethernaut-common/README.md) | Common utils used by several ethernaut-cli plugins |
| [ethernaut-interact](packages/ethernaut-interact/README.md) | Tasks for sending transactions and interacting with contracts |
| [ethernaut-interact-ui](packages/ethernaut-interact-ui/README.md) | Ui extensions for the ethernaut-interact package |
| [ethernaut-network](packages/ethernaut-network/README.md) | Tasks for interacting with different networks |
| [ethernaut-network-ui](packages/ethernaut-network-ui/README.md) | Ui extensions for the ethernaut-network package |
| [ethernaut-ui](packages/ethernaut-ui/README.md) | Intuitive navigation and interactive param collection for hardhat tasks |
| [ethernaut-util](packages/ethernaut-util/README.md) | Simple, everyday utilities for Ethereum devs |
| [ethernaut-util-ui](packages/ethernaut-util-ui/README.md) | Ui extensions for the ethernaut-util package |
| [ethernaut-wallet](packages/ethernaut-wallet/README.md) | Tasks for interacting from different Ethereum accounts |
| [ethernaut-wallet-ui](packages/ethernaut-wallet-ui/README.md) | Ui extensions for the ethernaut-wallet package |

</details>
Loading