Skip to main content

Ghost Build Tool - build and package GhostESP native SD apps

Project description

gbt — Ghost Build Tool

Build and package GhostESP native SD apps from the command line.

Install

pip install ghostbt

Requires Python 3.8+ and ESP-IDF (install via gbt setup).

Quick Start

# Set up ESP-IDF (one-time)
gbt setup

# Create a new app
gbt create my_app --name "My App"

# Build and package
gbt dist ./my_app --gapp

# Flash firmware to device
gbt firmware cardputer
gbt flash firmware --board cardputer --monitor

Commands

Command Description
gbt create <id> Scaffold a new native SD app
gbt build [dir] Build app with ESP-IDF
gbt package [dir] --gapp Package as folder or .gapp archive
gbt dist [dir] --gapp Build + package in one step
gbt setup Install/configure ESP-IDF toolchain
gbt boards List available firmware board configs
gbt firmware <board> Build GhostESP firmware
gbt flash firmware Flash firmware to device
gbt flash app Instructions for loading app via SD card
gbt monitor Serial monitor
gbt ports List serial ports

Requirements

  • Python 3.8 or later
  • ESP-IDF (auto-installed by gbt setup if missing)
  • Git (for gbt setup)

Links

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

ghostbt-0.1.0.tar.gz (34.3 kB view details)

Uploaded Source

Built Distribution

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

ghostbt-0.1.0-py3-none-any.whl (38.4 kB view details)

Uploaded Python 3

File details

Details for the file ghostbt-0.1.0.tar.gz.

File metadata

  • Download URL: ghostbt-0.1.0.tar.gz
  • Upload date:
  • Size: 34.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ghostbt-0.1.0.tar.gz
Algorithm Hash digest
SHA256 83930bf96f4a8c220d2d97e22172066cc3f96677e38bd711f261f882c73a5ef7
MD5 8b39b65f7d81be81f77413c05283c91e
BLAKE2b-256 5ee0687b68432f656a9678da8dc062b3fd6a0981e678fcf631c59d7ec2b223a9

See more details on using hashes here.

File details

Details for the file ghostbt-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ghostbt-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ghostbt-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 970f8b2478e970e2b66ae7a3c647b2a6ec95ea0c2648963e056be3aab34924b2
MD5 a916edd4e5d2032834f98465d98fce03
BLAKE2b-256 f7a14966d64470318800b85d4b4cf2b70d45fbd8fb4e4c3c45621ff24592f195

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