Skip to main content
  1. Documentation/
  2. Getting Started/

Quickstart

Table of Contents
Get from zero to a tasked agent in five minutes.

1. Install TantoC2
#

1
2
3
4
git clone <repo-url> tantoc2 && cd tantoc2
make all
python3 -m venv .venv && source .venv/bin/activate
pip install dist/*.whl

This installs tantoc2-server, tantoc2-cli, tantoc2-dev-agent, and tantoc2-web. See Installation for Docker and other options.

2. Start the Teamserver
#

1
tantoc2-server

Note the default admin password printed on first start.

3. Connect with the CLI
#

In a second terminal:

1
tantoc2-cli --url http://127.0.0.1:8443

Or connect manually:

1
2
3
tantoc2> connect http://127.0.0.1:8443
tantoc2> login admin
Password: <password-from-first-run>

4. Create an Engagement
#

All operations are scoped to an engagement — an isolated database for each operation.

1
2
tantoc2> engagements create "my-first-test"
Engagement passphrase: <choose-a-passphrase>

Select it:

1
2
tantoc2> engagements list
tantoc2> engagements use <engagement-id>

Your prompt updates to show the engagement name:

1
tantoc2[my-first]>

5. Start a Listener
#

Listeners receive agent callbacks:

1
2
tantoc2[my-first]> listeners create http --name my-listener --port 8080
tantoc2[my-first]> listeners start <listener-id>

6. Build and Deploy an Agent
#

Build a dev agent with config stamped in:

1
2
3
tantoc2[my-first]> agents generate dev_agent \
    --listener my-listener \
    --kill-date 2026-12-31

Deploy the agent in a third terminal:

1
tantoc2-dev-agent --server http://localhost:8080 --mode beacon --interval 5

7. Interact with the Agent
#

Back in the CLI, the agent appears:

1
2
tantoc2[my-first]> agents list
tantoc2[my-first]> agents use <hostname>

Send a survey task:

1
tantoc2[my-first]> task survey

Wait for the next beacon check-in (~5 seconds), then view the result:

1
2
tantoc2[my-first]> tasks list <agent-id>
tantoc2[my-first]> tasks result <agent-id> <task-id>

8. Browse Modules
#

List agent-loadable modules compatible with your agent:

1
2
tantoc2[my-first]> modules list
tantoc2[my-first]> modules compatible <agent-id>

9. Try Tools (Remote Operations)
#

Execute directly against remote services without an agent:

1
2
tantoc2[my-first]> tools list
tantoc2[my-first]> tools use ssh_command

What’s Next?
#

GoalGuide
Full operator workflowOperator Guide
Administration and RBACAdmin Guide
End-to-end walkthroughEngagement Walkthrough
Build custom modulesDeveloper Guide
API automationREST API Reference