Skip to main content

DebugTwin Copilot CLI - AI-powered firmware debugging assistant

Project description

DebugTwin CLI

AI-powered firmware debugging assistant for embedded systems.

Installation

pip install debugtwin-cli

Quick Start

1. Get an API Key

  1. Go to DebugTwin Dashboard
  2. Sign in with Google
  3. Navigate to API Keys in the header
  4. Click Generate Key and copy it

2. Login

debugtwin login --key YOUR_API_KEY

3. Start Chatting

debugtwin chat

4. Analyze a Log File

debugtwin analyze your_firmware.log

Commands

Command Description
debugtwin login --key KEY Authenticate with your API key
debugtwin chat Start an interactive debugging session
debugtwin analyze FILE Analyze a firmware log file
debugtwin ask "question" Ask a quick question
debugtwin version Show version information
debugtwin configure --url URL Configure custom API URL (for self-hosted)

Example Session

$ debugtwin chat
🚀 Starting DebugTwin Copilot CLI...
🔌 Connecting to: https://web-production-5988.up.railway.app

🤖 Hello! How can I help you debug your firmware today?

You: I'm seeing a HardFault on my STM32F4
🤖 I'd be happy to help debug that HardFault! Can you share:
1. The crash log or register dump
2. What was happening when it occurred
...

Requirements

  • Python 3.9+
  • Internet connection (for API access)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

debugtwin_cli-1.0.6.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

debugtwin_cli-1.0.6-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file debugtwin_cli-1.0.6.tar.gz.

File metadata

  • Download URL: debugtwin_cli-1.0.6.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for debugtwin_cli-1.0.6.tar.gz
Algorithm Hash digest
SHA256 19ad6f28f38fecabbe25ce2a56f76ffeba4254bd2496d830b8dfc94e7843026c
MD5 76979b49d2065cb162265b73af310531
BLAKE2b-256 70567ccea3cda455ac83d8c953dd2daba6c1268858fb9408d48d15fc1b4d6daf

See more details on using hashes here.

File details

Details for the file debugtwin_cli-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: debugtwin_cli-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for debugtwin_cli-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c29a259bf118761d7b0209e37e728857f67ad689b3004fe21b0bf8fec3265e28
MD5 45f84c1e32e5f4caa2cd089296ccf168
BLAKE2b-256 7243578bd4651bdd60ab9b563bb0a9768fed51f1754007ac7be3084bbe0c0bcc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page