{"id":21484896,"url":"https://github.com/zororaka00/kritisi","last_synced_at":"2026-02-02T04:04:54.584Z","repository":{"id":264142557,"uuid":"892053161","full_name":"zororaka00/kritisi","owner":"zororaka00","description":"A powerful AI-driven security audit tool for Solidity smart contracts, designed to detect vulnerabilities, enhance code quality, and ensure compliance with best practices. Ideal for developers seeking fast, reliable security insights.","archived":false,"fork":false,"pushed_at":"2024-11-24T14:23:14.000Z","size":144,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-10T17:38:38.957Z","etag":null,"topics":["ai","audit","blockchain","chatgpt","ethereum","security","smart-contract","solidity","tooling","vulnerability"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/kritisi","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zororaka00.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"zororaka00"}},"created_at":"2024-11-21T12:32:36.000Z","updated_at":"2024-11-24T14:23:17.000Z","dependencies_parsed_at":"2025-07-15T15:35:48.212Z","dependency_job_id":"cc4b15e6-8b23-40f4-8c83-6268e7d06cef","html_url":"https://github.com/zororaka00/kritisi","commit_stats":null,"previous_names":["zororaka00/kritisi"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/zororaka00/kritisi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zororaka00%2Fkritisi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zororaka00%2Fkritisi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zororaka00%2Fkritisi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zororaka00%2Fkritisi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zororaka00","download_url":"https://codeload.github.com/zororaka00/kritisi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zororaka00%2Fkritisi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29004695,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T01:32:03.847Z","status":"online","status_checked_at":"2026-02-02T02:00:07.448Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","audit","blockchain","chatgpt","ethereum","security","smart-contract","solidity","tooling","vulnerability"],"created_at":"2024-11-23T13:12:49.491Z","updated_at":"2026-02-02T04:04:54.568Z","avatar_url":"https://github.com/zororaka00.png","language":"JavaScript","funding_links":["https://github.com/sponsors/zororaka00"],"categories":[],"sub_categories":[],"readme":"\n# Kritisi: AI-Powered Security Audit Tool for Solidity Smart Contracts\n\n[![CodeFactor](https://www.codefactor.io/repository/github/zororaka00/kritisi/badge/main)](https://www.codefactor.io/repository/github/zororaka00/kritisi) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=zororaka00_kritisi\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=zororaka00_kritisi)\n\n**Kritisi** is an AI-powered tool designed to analyze the security and documentation of Solidity code. This tool helps developers detect vulnerabilities, improve code quality, and ensure compliance with best practices.\n\n---\n\n## ✨ Key Features\n\n- **Security Audit**: Analyze Solidity code to identify security vulnerabilities with structured reporting.\n- **NatSpec Documentation**: Automatically add NatSpec documentation to functions within Solidity code.\n- **Code Merging**: Merge all imported Solidity files into a single file for streamlined development.\n- **Ease of Use**: CLI-based, allowing for simple and efficient interaction.\n- **AI Service Support**: Supports OpenAI and Groq services for flexibility.\n\n---\n\n## 🚀 Installation\n\nTo use **Kritisi**, make sure you have the latest version of Node.js installed. Then, install the tool globally using the following command:\n\n```bash\nnpm install -g kritisi\n```\n\n---\n\n## 📘 Usage Instructions\n\nOnce **Kritisi** is installed globally, you can use it from the command line by typing `kritisi` followed by the desired command. Here are the available commands:\n\n1. **View Help**\n   To see a list of available commands, use:\n\n   ```bash\n   kritisi help\n   ```\n\n   Example output:\n\n   ```\n   Usage: kritisi [options] [command]\n\n   A powerful AI-driven security audit tool for Solidity smart contracts.\n   Detect vulnerabilities, enhance code quality, and ensure compliance with best practices.\n\n   Options:\n     -V, --version           output the version number\n     -h, --help              display help for command\n\n   Commands:\n     setkey                 Set an API key for the selected service\n     setmodel               Set the AI model for the selected service\n     natspec                Process NatSpec documentation for Solidity files\n     security               Run a security audit for Solidity smart contracts\n     merger                 Merge all imported Solidity files into a single file\n     help                   Display help information for available commands\n\n   Run 'kritisi \u003ccommand\u003e --help' for detailed usage of a specific command.\n   ```\n\n2. **Set API Key**\n   Before using the AI services, you need to set up your API key. Use the following command:\n\n   ```bash\n   kritisi setkey --service \u003cservice\u003e\n   ```\n\n   `\u003cservice\u003e`: Specify the service to be used, such as `openai` or `groq`. Example:\n\n   ```bash\n   kritisi setkey --service openai\n   ```\n\n   You will be prompted to enter your API key.\n\n3. **Set AI Model**\n   Set the AI model for the selected service, use the following command:\n\n   ```bash\n   kritisi setmodel --service \u003cservice\u003e\n   ```\n\n   `\u003cservice\u003e`: Specify the service to be used, such as `openai` or `groq`. Example:\n\n   ```bash\n   kritisi setmodel --service openai\n   ```\n\n   You will be prompted to input the model name interactively.\n\n4. **Add NatSpec Documentation**\n   To automatically add NatSpec documentation to your Solidity code, use the following command:\n\n   ```bash\n   kritisi natspec --service \u003cservice\u003e --path \u003cpath\u003e\n   ```\n\n   `\u003cservice\u003e`: Specify the AI service (e.g., `openai` or `groq`).  \n   `\u003cpath\u003e`: Specify the path to your Solidity file. Example:\n\n   ```bash\n   kritisi natspec --service openai --path ./contracts/MyContract.sol\n   ```\n\n5. **Security Audit**\n   To run a security audit on your Solidity contracts, use:\n\n   ```bash\n   kritisi security --service \u003cservice\u003e --path \u003cpath\u003e\n   ```\n\n   `\u003cservice\u003e`: Specify the AI service (e.g., `openai` or `groq`).  \n   `\u003cpath\u003e`: Specify the path to your Solidity file. Example:\n\n   ```bash\n   kritisi security --service groq --path ./contracts/MyContract.sol\n   ```\n\n   The audit results will be saved as a PDF file in the same location as your Solidity file.\n\n6. **Merge Solidity Files**\n   To merge all imported Solidity files into a single file, use:\n\n   ```bash\n   kritisi merger --path \u003cpath\u003e\n   ```\n\n   `\u003cpath\u003e`: Specify the path to your Solidity file. Example:\n\n   ```bash\n   kritisi merger --path ./contracts/MyContract.sol\n   ```\n\n   The merged file will be saved with `_merge` appended to the original file name.\n\n---\n\n## 📂 Example Output\n\n### Security Audit\n\nThe results are presented as a JSON report converted into a PDF file like this:\n\n```json\n{\n  \"high\": [\n    {\n      \"issue\": \"Reentrancy vulnerability in withdraw function.\",\n      \"suggestion\": \"Use the Checks-Effects-Interactions pattern.\",\n      \"code_highlight\": \"function withdraw() public { ... }\"\n    }\n  ],\n  \"medium\": [],\n  \"low\": []\n}\n```\n\n### File Merge\n\nUpon successful merging, the output will indicate the location of the merged file:\n\n```\n✔ Files merged successfully. Output file: /absolute/path/to/MyContract_merge.sol\n```\n\n---\n\n## 🤝 Contributing\n\nWe greatly appreciate your contributions! Please fork this repository and submit a pull request with your changes or additions.\n\n## 🛠 Support\n\nIf you encounter any issues or have questions, please open an issue in this repository or contact us at rakawidhiantoro@gmail.com.\n\n## 📄 License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n---\n\n🎉 Thank you for using **Kritisi**! We hope this tool proves beneficial in enhancing the security and quality of your smart contracts.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzororaka00%2Fkritisi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzororaka00%2Fkritisi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzororaka00%2Fkritisi/lists"}