diff --git a/README.md b/README.md index 7dae79e6..f9c8ebd2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/packages/ethernaut-cli/hardhat.config.js b/packages/ethernaut-cli/hardhat.config.js index 21aad8c6..69cb86de 100644 --- a/packages/ethernaut-cli/hardhat.config.js +++ b/packages/ethernaut-cli/hardhat.config.js @@ -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', diff --git a/packages/ethernaut-cli/package.json b/packages/ethernaut-cli/package.json index 829b35a2..64afa509 100644 --- a/packages/ethernaut-cli/package.json +++ b/packages/ethernaut-cli/package.json @@ -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": {