Skip to content

docs: README opens with why shambu exists #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Shavvimal merged 1 commit into from
Oct 29, 2026
Merged

docs: README opens with why shambu exists #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ All notable changes to this project are documented here. The format follows
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Changed
- README opens with why the tool exists: agents can sweep orientations, print sequences and tower options in
parallel and iterate on plates in a way a person in the Studio GUI cannot; Studio stays the final pass.

## [0.6.0] - 2026-10-29

A shambu project now opens in Bambu Studio with the process it was sliced with. On 2026-10-29 the owner opened a
Expand Down
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
![python](https://img.shields.io/badge/python-3.11%2B-blue)

**Why this exists.** Bambu Studio is a one-plate-at-a-time tool: you arrange, pick a profile, slice, read the
estimate, and try again. Every variant costs a human a few minutes, so nobody explores more than a handful. shambu
turns that loop into a command an agent can run many times over, in parallel: the same parts in six orientations,
by object and by layer, with and without a prime tower, on one plate or two, each slice read back as grams and
minutes (`shambu sweep` does exactly this). Because it ships as a Claude Code skill, several agents can prepare
several plates at once, each with its own placement and reach checks, and iterate on the result in a way a person
in the GUI cannot. Studio stays the place where you look at the plate and press Print; the search for the best plate
happens before that, at machine speed, with every rule the slicer enforces checked first.

STLs in, a checked Bambu Studio project out. `shambu` drives Bambu Studio's own command line to turn a short
JSON spec into a `.3mf` project (or a sliced `.gcode.3mf` with time and filament estimates) with the parts placed,
the process settings applied, the right filament on each part and the plate type set. It also inspects and
Expand Down
Loading