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.1.tar.gz (34.5 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.1-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ghostbt-0.1.1.tar.gz
  • Upload date:
  • Size: 34.5 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.1.tar.gz
Algorithm Hash digest
SHA256 8698beb47a94f0ab4d3cd78ea1e3549befe111355c6d975c2345dd292060a5a3
MD5 a974e9a120b214990b52e0254628d3c2
BLAKE2b-256 82dae8bc01bd0cdb870ba98450991fa06d5e168974f3a38c6c06aa9454bade75

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ghostbt-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 38.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4104cbb943322121646c796c9e5e1acf615684c035785d2df42bae533d0937bf
MD5 8a8ca80d45634b8839b308095242031b
BLAKE2b-256 edf8657b45d6255ef25ac268777752fde588b83958d57dee0eee67679ea7302c

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