Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eternauta1337 committed Mar 13, 2024
1 parent ad2ccc8 commit 28a64b0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# ethernaut-cli

Ethereum swiss army ~knife~ ~superweapon~ ~cli~ ~tool~ thing?
for Ethereum hackers.
The ethernaut-cli is basically an ai agent that is given access to web3 actions through hardhat tasks. It is a cli meant to be installed globally, and used like:

`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

`npm i -g ethernaut-cli`

Warning! This software is still in alpha, and very experimental rn.
Warning!!! This software is in alpha, and very experimental atm.

![danger](https://giphy.com/embed/X8t6i3zOvLfGw)

## Intuitive navigation

Expand Down
2 changes: 1 addition & 1 deletion packages/ethernaut-cli/hardhat.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ require('ethernaut-challenges')

const txt = figlet.textSync('ethernaut-cli', { font: 'Graffiti' })
chalkAnimation.rainbow(txt).render()
console.log(`v${version}`)
console.log(`v${version} - Warning!!! ALPHA version. Use at your own risk.`)

module.exports = {
solidity: '0.8.19',
Expand Down
2 changes: 1 addition & 1 deletion packages/ethernaut-cli/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "ethernaut-cli",
"version": "1.0.10",
"description": "Swiss army knife command line application for Ethereum devs",
"description": "Ai agent cli with web3 capabilities",
"license": "ISC",
"author": "theethernaut",
"repository": {
Expand Down

0 comments on commit 28a64b0

Please sign in to comment.