DEV Community

Raka Widhi Antoro
Raka Widhi Antoro

Posted on

🚀 Getting Started with kritisi CLI: An AI-Driven Security Tool for Solidity

#blockchain #security #solidity #ethereum

The kritisi CLI is a powerful tool for developers working with Solidity smart contracts. It leverages AI to enhance code quality, detect vulnerabilities, and ensure compliance with best practices. Let’s dive into how to install and use this tool step by step.

✨ Features

  • 🔐 Set API Keys for AI services like OpenAI and Groq.
  • 🤖 Set AI Models for tailored results.
  • 🛠️ Merge Solidity Files with ease.
  • 📝 Generate NatSpec Documentation using AI.
  • 📊 Run Security Audits with detailed severity reports.

🚀 Installation

First, ensure you have Node.js installed on your system. Then install the kritisi CLI globally:

npm install -g kritisi
Enter fullscreen mode Exit fullscreen mode

Verify the installation:

kritisi --version
Enter fullscreen mode Exit fullscreen mode

🛠️ Usage Guide

1. Register for API Keys

To use AI features, you need API keys from OpenAI and Groq. Follow these steps:

OpenAI

  1. Go to OpenAI.
  2. Sign up or log in to your account.
  3. Navigate to the API section and generate a new API key.
  4. Save the API key securely.

Groq

  1. Visit Groq and create an account.
  2. Once logged in, go to the developer section to generate an API key.
  3. Save the API key securely.

2. Set Your API Key

After obtaining API keys, set them up for the selected service.

Command: 

kritisi setkey --service <service>
Enter fullscreen mode Exit fullscreen mode

Example: 

kritisi setkey --service openai
Enter fullscreen mode Exit fullscreen mode

You will be prompted to enter your API key interactively. For example:

Enter the API key openai:
Enter fullscreen mode Exit fullscreen mode

Once entered, the key will be securely saved.

3. Set AI Model

Select the AI model for the service you’re using.

Command: 

kritisi setmodel --service <service>
Enter fullscreen mode Exit fullscreen mode

Example: 

kritisi setmodel --service openai
Enter fullscreen mode Exit fullscreen mode

You will be prompted to enter the model name interactively:

Enter the model name for openai (e.g., 'gpt-4'):
Enter fullscreen mode Exit fullscreen mode

4. Merge Solidity Files

Combine all imported Solidity files into a single file with this handy command.

Command: 

kritisi merger --path <path-to-solidity-file>
Enter fullscreen mode Exit fullscreen mode

Example: 

kritisi merger --path ./contracts/MyContract.sol
Enter fullscreen mode Exit fullscreen mode

This will generate a merged file with _merge appended to the original file name.

5. Add NatSpec Documentation

Automatically add NatSpec comments to your Solidity code.

Command: 

kritisi natspec --service <service> --path <path-to-solidity-file>
Enter fullscreen mode Exit fullscreen mode

Example: 

kritisi natspec --service openai --path ./contracts/MyContract.sol
Enter fullscreen mode Exit fullscreen mode

6. Run Security Audit

Analyze your smart contract for security vulnerabilities and generate a detailed report.

Command: 

kritisi security --service <service> --path <path-to-solidity-file>
Enter fullscreen mode Exit fullscreen mode

Example: 

kritisi security --service groq --path ./contracts/MyContract.sol
Enter fullscreen mode Exit fullscreen mode

The security report will be saved as a PDF in the same directory.

📚 Example Workflow

Let’s walk through a simple example:

  1. Register for API Keys:

  2. Set the OpenAI API Key:

    kritisi setkey --service openai

    Enter your API key when prompted.

  3. Set the AI Model:

    kritisi setmodel --service openai

    Provide the model name (e.g., gpt-4).

  4. Run a Security Audit:

    kritisi security --service openai --path ./contracts/MyContract.sol

    Check the generated PDF for the detailed report.

🔧 Troubleshooting

  • If you encounter errors related to missing API keys, ensure you have set them using the setkey command.
  • Use the --help flag with any command to get detailed usage instructions: 
kritisi <command> --help
Enter fullscreen mode Exit fullscreen mode

🌟 Conclusion

The kritisi CLI empowers Solidity developers with AI-driven insights, streamlining the auditing and documentation process. Whether you're ensuring security compliance or generating comprehensive documentation, this tool has you covered.

🛠️ Resources

Happy Coding! 🎉

Top comments (0)

Read next

scofieldidehen profile image

Who is a Hacker?

Scofield Idehen -

benzellat_djameleddine_3 profile image

The Ultimate Guide to Protecting Your Online Privacy in 2024

Benzellat Djamel Eddine -

benzellat_djameleddine_3 profile image

Top 10 Cybersecurity Threats You Need to Know About This Year 2024

Benzellat Djamel Eddine -

naveedsaeed profile image

Running a Database Server on EC2: Best Practices and Considerations

Muhammad Naveed -