Quickstart
Ten minutes from installing the CLI to a verified contract on BSC testnet. Scoping happens before any of it, and produces a file you can read.
EXAMPLE — the commands below illustrate the intended interface. The install URL is not live yet.
1 · Install and scope
Everything starts with a sentence. Not a spec, not a schema — a sentence in the words you would use to describe the problem to a friend.
# one binary, no project scaffolding to accept
curl -fsSL https://get.fluxape.dev | sh
flux login
flux scope "a tip jar my viewers can use without making an account"The scoping run writes plan.md into the working directory. It is a plain markdown file with four parts: what the agent thinks you meant, what it would keep, what it would cut with a reason for each, and the questions it refuses to answer on your behalf.
2 · Argue with the plan
This is the stage that decides whether everything after it is cheap. Edit the file. Delete things from Keep. Move things out of Cut if you disagree — but the reason stays attached, so future-you can see what past-you overrode.
A plan with everything left in is allowed. The agent will tell you what it thinks that will cost before it starts building, and then it will build it.
3 · Build and ship
# the plan is a file. edit it, then build from it.
flux plan edit # opens plan.md
flux build # contracts, interface, tests
# testnet first, always
flux ship --network bsc-testnet
# mainnet prepares a transaction; you sign it
flux ship --network bsc --prepare-onlyTestnet is not optional and is not a flag you can skip — a mainnet ship refuses to run until the same plan has passed on bsc-testnet. Mainnet deployment is always --prepare-only: the agent builds the transaction and hands it to you to sign. It never holds a key.
Where to go next
- Writing a first prompt — the sentence matters more than anything else you will type.
- Working with the plan — how to read a cut list, and when to override it.
- Limits — what it will not do, and why that is the useful part.