{"_id":"@bellatricks/audit-ai","_rev":"1-4bb1879e96a02bfce89cba72c943d2c8","name":"@bellatricks/audit-ai","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@bellatricks/audit-ai","version":"1.0.0","keywords":["cli","audit","smart contract","gemini ai"],"author":{"name":"Busayo Samuel"},"license":"MIT","_id":"@bellatricks/audit-ai@1.0.0","maintainers":[{"name":"bellatricks","email":"Busayosamuel2016@gmail.com"}],"bin":{"audit-ai":"index.js"},"dist":{"shasum":"e53f11af4205976fb4514109f66d2b9b7502f484","tarball":"https://registry.npmjs.org/@bellatricks/audit-ai/-/audit-ai-1.0.0.tgz","fileCount":4,"integrity":"sha512-ipG1tYMO1JBpzbMMUaRlc3+9B/sFQAYLbGPMw38vnF8msP6Gg0EKJqt68KDuz2V1W8Cw9bD0vXnKRcKLUYIEFw==","signatures":[{"sig":"MEUCIH4C0Wfj345vKh1XHXMVtY+1e+xbYQJxEuaHBoTMG1VeAiEAiiV3Sv50thSIWDShogjoKjR91GS9910ROBHCrbIZsJ4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7107},"main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"node index.js"},"_npmUser":{"name":"bellatricks","email":"Busayosamuel2016@gmail.com"},"_npmVersion":"10.7.0","description":"A CLI tool to analyze smart contracts using Gemini AI","directories":{},"_nodeVersion":"20.14.0","dependencies":{"inquirer":"^11.0.1","commander":"^12.1.0","@google/generative-ai":"^0.19.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/audit-ai_1.0.0_1726514360005_0.17702694877312664","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@bellatricks/audit-ai","version":"1.0.1","main":"index.js","bin":{"audit-ai":"index.js"},"scripts":{"start":"node index.js","test":"echo \"Error: no test specified\" && exit 1"},"keywords":["cli","audit","smart contract","gemini ai"],"author":{"name":"Busayo Samuel"},"license":"MIT","description":"A CLI tool to analyze smart contracts using Gemini AI","dependencies":{"@google/generative-ai":"^0.19.0","commander":"^12.1.0","inquirer":"^11.0.1"},"_id":"@bellatricks/audit-ai@1.0.1","_nodeVersion":"20.14.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-cYdG9EaoADFRmFfd4zLnxrdY0UHZyAJI2Ul4rnsM2qz3U4AO7+j1wRkCORcDAHsT5RgQXgdDq7cJDScfURlNow==","shasum":"cd502319c1edd91211ff121ff4523e310c3ace96","tarball":"https://registry.npmjs.org/@bellatricks/audit-ai/-/audit-ai-1.0.1.tgz","fileCount":5,"unpackedSize":9364,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICo3j5mTVjCRqZ2pA4tFAv3rfWh4eijhFS+wMDm6x9VeAiBaRnjk+Bthw99cXd32SlsCNuKP7yuIRKyGw3rsj2w70w=="}]},"_npmUser":{"name":"bellatricks","email":"Busayosamuel2016@gmail.com"},"directories":{},"maintainers":[{"name":"bellatricks","email":"Busayosamuel2016@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/audit-ai_1.0.1_1726514650181_0.2911785571050143"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-16T19:19:19.856Z","modified":"2024-09-16T19:24:10.522Z","1.0.0":"2024-09-16T19:19:20.195Z","1.0.1":"2024-09-16T19:24:10.350Z"},"author":{"name":"Busayo Samuel"},"license":"MIT","keywords":["cli","audit","smart contract","gemini ai"],"description":"A CLI tool to analyze smart contracts using Gemini AI","maintainers":[{"name":"bellatricks","email":"Busayosamuel2016@gmail.com"}],"readme":"# @bellatricks/audit-ai\r\n\r\n**Analyze smart contracts using Gemini AI**\r\n\r\nThis CLI tool allows you to audit and analyze Solidity smart contracts using Gemini AI. It checks for vulnerabilities, gas optimization issues, and more.\r\n\r\n## Features\r\n\r\n- Analyzes Solidity smart contracts.\r\n- Uses Gemini AI to identify potential security risks and performance improvements.\r\n- Provides a comprehensive report on contract vulnerabilities and suggestions for optimization.\r\n\r\n## Installation\r\n\r\nInstall the package globally using npm:\r\n\r\n```bash\r\nnpm install -g @bellatricks/audit-ai\r\n```\r\n\r\n## Usage\r\n\r\nOnce installed, you can use the `audit-ai` command in your terminal to analyze smart contracts.\r\n\r\n### Commands\r\n\r\n#### Analyze a Smart Contract\r\n\r\nUse the `check` command followed by the path to the Solidity file you want to analyze:\r\n\r\n```bash\r\naudit-ai check <path-to-smart-contract>\r\n```\r\n\r\nFor example:\r\n\r\n```bash\r\naudit-ai check contracts/MyContract.sol\r\n```\r\n\r\n### Example\r\n\r\n```bash\r\naudit-ai check contracts/MyContract.sol\r\n```\r\n\r\nYou will be prompted to enter your Gemini API key:\r\n\r\n```\r\nEnter your Gemini API key:\r\n```\r\n\r\nAfter providing your API key, the tool will analyze your smart contract and display the results in your terminal.\r\n\r\n## Setup\r\n\r\nTo use this tool, you need a valid Gemini API key. If you don't have one, visit the [Gemini website](https://gemini.com) to obtain it.\r\n\r\n## API Key Prompt\r\n\r\nWhen you run the `check` command, you will be prompted to enter your API key. The key will be used for analyzing your smart contract and generating an audit report.\r\n\r\n### Example Prompt:\r\n\r\n```\r\nEnter your Gemini API key:\r\n```\r\n\r\n### Requirements\r\n\r\n- Node.js v12 or above.\r\n- A valid Gemini AI API key.\r\n\r\n## Project Structure\r\n\r\n```text\r\n.\r\n├── bin\r\n│   └── audit-ai.js        # Entry point for the CLI\r\n├── src\r\n│   └── ai-prompt.js       # Handles contract analysis using Gemini AI\r\n├── package.json           # NPM package configuration\r\n└── README.md              # Documentation\r\n```\r\n\r\n## Contributing\r\n\r\nWe welcome contributions! If you'd like to improve this package, please submit a pull request or open an issue.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License.\r\n\r\n---\r\n","readmeFilename":"README.md"}