Skip to main content

​
Before you begin

Make sure you have:

​
Get started in three steps

1

Install the Hacktron CLI

If you are on Windows, you need to use WSL.
curl -fsSL https://cli.hacktron.ai/install.sh | bash
2

Verify installation

hacktron --version
3

Login to your account

The Hacktron CLI requires an account on the Hacktron Platform. You only need to login once, and the CLI will remember your credentials.
hacktron login

​
Start your first session

Open your terminal in any directory containing code you want to scan, and start the Hacktron CLI. 
cd /path/to/your/project
hacktron
cli_home

You’ll see the welcome screen with a list of available commands.

​
Give your first task

You are now in an interactive session. Try one of these commands: 
> Check for XSS vulnerabilities

> Check the Terraform code for misconfigurations
Hacktron will analyse the codebase and perform a vulnerability scan, using taint analysis to find potential vulnerabilities. You can also ask more general questions to understand the codebase. 
> What technologies does this project use?

> What are the API endpoints?

​
What’s next?

Explore more advanced features:

Agents

Learn how to use agents in the CLI.

Shell commands

Learn how to use shell commands in the CLI.
You can use the /help command at any time within an interactive session to get more information on how to use the CLI. 
/help