FRAMEWORK_TOOL(1)

📦
version 0.6.5 · 2 versions
, in ubuntu stonking

💖 FRAMEWORK_TOOL 💖

okay bestie, welcome to framework_tool(1) — the General Commands Manual girlie of your dreams ✨

✨ NAME ✨

framework_tool — control and query Framework Computer systems 💻🦋

🌸 SYNOPSIS 🌸

framework_tool [-v -...] command [argument]

🎀 DESCRIPTION 🎀

so like, framework_tool is a command-line utility for interacting with Framework Computer laptops and desktops. no cap. it talks to the Embedded Controller (EC) to query firmware versions, battery and USB-C status, thermal data, privacy and intrusion switches, and expansion card details. it's giving full system gossip. 👑

it can also adjust system settings and flash EC firmware. main character energy fr fr.

⚠️ heads up babe: most operations require root privileges. don't forget your sudo or she simply will not cooperate 😭

✨ OPTIONS ✨

🧚 Firmware Information

  • --versions — list current firmware versions (BIOS, EC, PD controllers, retimer, touchpad, touchscreen). the whole squad, accounted for 💅
  • --version — show tool version information. add -vv for more details, iykyk
  • --features — show features supported by the firmware
  • --esrt — display the UEFI ESRT table
  • --meinfo [dmidecode-dump] — show Intel ME information from SMBIOS. optionally provide a path to a dmidecode binary dump file 🍓
  • --boardid — print all board IDs
  • --pd-bin file — parse version from a PD firmware binary file
  • --ec-bin file — parse version from an EC firmware binary file
  • --capsule file — parse UEFI capsule information from a binary file
  • --h2o-capsule file — parse H2O BIOS capsule information from a binary file
  • --dump file — dump extracted UX capsule bitmap image to a file 🖼️

🌈 System Status

  • --power — show current power status of battery and AC. add -vv for more details.
  • --thermal — print thermal information (temperatures and fan speed) 🔥
  • --sensors — print sensor information (ALS, G-Sensor)
  • --pdports — show USB-C PD port state
  • --pdports-chromebook — show PD port info (generic Chromium EC)
  • --pd-info — show details about the PD controllers
  • --dp-hdmi-info — show details about connected DisplayPort or HDMI expansion cards
  • --audio-card-info — show details about connected audio expansion cards. requires root
  • --privacy — show privacy switch statuses (camera and microphone) 🙈
  • --intrusion — show status of the intrusion switch
  • --inputdeck — show status of the input modules (Framework 16 only)
  • --expansion-bay — show status of the expansion bay (Framework 16 only)
  • --get-gpio [name] — get GPIO value by name, or all GPIOs if no name is given
  • --stylus-battery — check stylus battery level (USI 2.0 stylus only) 🖊️
  • --uptimeinfo — show EC uptime information
  • --s0ix-counter — show S0ix counter
  • --console recent|follow — read EC console output 📺

💅 Settings

  • --kblight [percent] — get or set keyboard backlight percentage ✨
  • --charge-limit [percent] — get or set the maximum battery charge limit
  • --charge-current-limit milliwatts [port] — set maximum charge current limit
  • --charge-rate-limit rate [port] — set maximum charge rate limit
  • --fp-led-level [level] — get or set fingerprint LED brightness level
  • --fp-brightness [percent] — get or set fingerprint LED brightness percentage
  • --tablet-mode auto|on|off — set tablet mode override
  • --touchscreen-enable true|false — enable or disable the touchscreen
  • --inputdeck-mode auto|on|off — set input deck power mode (Framework 12, 13, 16)
  • --fansetduty [fan percent] — set fan duty cycle (0-100%) 🌬️
  • --fansetrpm [fan rpm] — set fan speed in RPM
  • --autofanctrl [fan] — turn on automatic fan speed control
  • --ec-hib-delay [seconds] — get or set EC hibernate delay (S5 to G3 transition)
  • --remap-key matrix from to — remap a key by changing its scancode ⌨️
  • --rgbkbd start color ... — set per-key RGB colours starting at start 🌈

🔥 Firmware Flashing

💀 okay these ones are serious. read the warnings, bestie. like actually.
  • --flash-ec file — flash EC (RO and RW) with new firmware. may render hardware unbootable. requires --force
  • --flash-ro-ec file — flash EC RO region with new firmware. may render hardware unbootable. requires --force
  • --flash-rw-ec file — flash EC RW region with new firmware
  • --dump-ec-flash file — dump EC flash contents to a file
  • --flash-full-ec file — flash full EC flash (RO, RW, and all regions) with new firmware. may render hardware unbootable. requires --force
  • --dp-hdmi-update file — update the firmware of a connected DisplayPort or HDMI expansion card

👑 Advanced Options

  • --driver type — select the EC driver to use. by default port I/O is used
  • --pd-addrs addr1 addr2 addr3 — specify I2C addresses of the PD chips. must be used together with --pd-ports
  • --pd-ports port1 port2 port3 — specify I2C ports of the PD chips. must be used together with --pd-addrs
  • --host-command cmd version [data ...] — send a raw EC host command
  • --pd-reset controller — reset a specific PD controller (for debugging only).
  • --pd-disable controller — disable all ports on a specific PD controller (for debugging only)
  • --pd-enable controller — enable all ports on a specific PD controller (for debugging only)
  • --reboot-ec mode — control EC RO/RW jump
  • --device type — hardware device type to compare against --compare-version
  • --compare-version version — version string to compare with the on-device version.
  • --hash file — hash a file of arbitrary data using the EC hash algorithm
  • --test — run self-test to check if EC communication is working 🧪
  • --test-retimer — run self-test to check if retimer communication is working
  • --dry-run — simulate execution of a command without applying changes
  • --force — allow execution of unsafe commands

⭐ General Options

  • -v — increase verbosity. repeat for more output (e.g., -vv)
  • -h, --help — print help information

💜 EXIT STATUS 💜

the framework_tool utility exits 0 on success, and >0 if an error occurs.

translation: 0 = slay, >0 = not slay 😭

🦋 EXAMPLES 🦋

list all firmware versions:

# framework_tool --versions

show battery and AC status:

# framework_tool --power

get keyboard backlight level:

# framework_tool --kblight

set keyboard backlight to 50%:

# framework_tool --kblight 50

set battery charge limit to 80%:

# framework_tool --charge-limit 80

parse version from EC firmware file:

$ framework_tool --ec-bin ec.bin

flash EC RW firmware:

# framework_tool --flash-rw-ec ec_rw.bin

🌸 SEE ALSO 🌸

dmidecode(8)

(the one other page in the group chat 💖)

🎀 AUTHORS 🎀

framework_tool was written by Framework Computer Inc <hello@frame.work> 🫶

this manual page was written by Nadzeya Hutsko <nadzeya@debian.org> — icon behavior, genuinely ✨

and that's the whole page bestie!! go forth and query your EC 💅

Debian · April 8, 2026 · FRAMEWORK_TOOL(1) — mwah, love u, bye 💖🦋✨

📦 where this page comes from