auditsmartcontract-cli

auditsmartcontract-cli is a command-line interface (CLI) tool for auditing smart contracts using OpenAI's analysis capabilities. It helps developers check their smart contracts for potential vulnerabilities and issues by leveraging AI-based audits.

Features

• AI-Powered Auditing: Utilizes OpenAI's capabilities to analyze smart contract code.
• Detailed Reports: Get detailed feedback and recommendations for improvement.
• Easy to Use: Simple commands to quickly audit your smart contracts.

Installation

npm i auditsmartcontract-cli

usage

npx auditsmartcontract-cli

Once installed, you can use the CLI tool to audit your smart contract files.

auditai check <filename>

Usage

Once installed or run via NPX, you can use the CLI tool to audit your smart contract files.

Commands

Analyze a Smart Contract

To analyze a smart contract, use the following command:

auditai check <file>

• <file>: Path to the smart contract file you want to analyze.

Example:

auditai check MyToken.sol

This will analyze the MyToken.sol contract and provide a detailed report of any detected issues.

Options

• -V, --version: Output the version number of the CLI tool.
• -h, --help: Display help for the CLI tool or any specific command.

Help Command

For help with any command, run:

auditai help [command]

Example:

auditai help check

Example Workflow

1. Navigate to your project folder where your smart contract is located.

2. Run the audit on your smart contract file:

   auditai check MyToken.sol

3. Review the output for any detected issues and recommendations.

Supported Platforms

• Ethereum
• Binance Smart Chain (BSC)
• Polygon
• Avalanche

Contributing

We welcome contributions! If you'd like to contribute to auditsmartcontract-cli, follow these steps:

1. Fork the repository at https://github.com/sgr-0007/auditsmartcontract-cli.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes and commit them (git commit -am 'Add your feature').
4. Push the branch to your fork (git push origin feature/your-feature).
5. Create a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you encounter any issues or have questions, feel free to open an issue in the GitHub repository or contact us via email.