BUILDBOT(1)

✨ NAME ✨

buildbot — it's the BUILDBOT(1) page from User Commands, and it's literally a tool for managing buildbot master instances 💅

🎀 SYNOPSIS 🎀

🌸 General Invocation

buildbot [ global options ] command [ command options ]

buildbot command -h|--help

🌸 Command Options

buildbot create-master [ -q|--quiet ] [ -f|--force ] [ -r|--relocatable ] [ -n|--no-logrotate ] [ -s|--log-size SIZE ] [ -l|--log-count COUNT ] [ -c|--config CONFIG ] [ --db DATABASE ] [ PATH ]

buildbot upgrade-master [ -q|--quiet ] [ -r|--replace ] [ --db DATABASE ] [ PATH ]

buildbot [ --verbose ] { start|stop|restart|sighup|reconfig } [ PATH ]

buildbot sendchange [ -m|--master MASTER ] [ -u|--username USERNAME ] [ -R|--repository REPOSITORY ] [ -P|--project PROJECT ] [ -b|--branch BRANCH ] [ -C|--category CATEGORY ] [ -r|--revision REVISION ] [ --revision-file REVISIONFILE ] [ -p|--property PROPERTY ] [ -c|--comments MESSAGE ] [ -F|--logfile LOGFILE ] [ -w|--when TIMESTAMP ] FILES...

buildbot try [ --wait ] [ -n|--dry-run ] [ --get-builder-names ] [ -c|--connect {ssh|pb} ] [ --tryhost HOSTNAME ] [ --trydir PATH ] [ -m|--master MASTER ] [ -u|--username USERNAME ] [ --passwd PASSWORD ] [ --diff DIFF ] [ --patchlevel PATCHLEVEL ] [ --baserev BASEREV ] [ --vc {cvs|svn|tla|baz|darcs|p4} ] [ --branch BRANCH ] [ -b|--builder BUILDER ] [ --properties PROPERTIES ] [ --try-topfile FILE ] [ --try-topdir PATH ]

buildbot tryserver [ --jobdir PATH ]

buildbot checkconfig [ CONFIGFILE ]

buildbot [ --verbose ] { start|stop|restart|sighup|reconfig } [ PATH ]

buildbot [ --verbose ] { --help|--version }

(and yes bestie, the start|stop|restart|sighup|reconfig line really does show up twice in here — that's not me being extra, that's just what the page says 🙈)

🦋 DESCRIPTION 🦋

The buildbot command-line tool is your little remote control for a buildmaster — you can use it to start or stop a buildmaster, and to interact with a buildmaster instance that's already running. 👑

Some of its subcommands are for the buildmaster admins (the people keeping the whole thing alive), and some are for developers who are out here editing the code that the buildbot is monitoring. Two different audiences, one command, main character energy fr fr.

💖 OPTIONS 💖

👑 Commands

• create-master — creates a directory for a brand new buildmaster and populates it 🎀
• upgrade-master — takes a buildmaster directory you already have and upgrades it for the current version
• start — starts a buildmaster ✨
• stop — stops a buildmaster
• restart — restarts a buildmaster 🔄
• sighup|reconfig — sends a SIGHUP signal to the buildmaster so it re-reads the config file
• sendchange — sends a change to the buildmaster 📨
• try — runs a build with your local changes. Important: this command needs the buildmaster to be configured in advance to accept build requests like this. The docs have the details on how to set that up, so go read them, bestie.
• tryserver — the buildmaster-side try support function. Not for users. Hands off, that's staff only 💀
• checkconfig — validates your buildbot master config file ✅

🌈 Global options

• -h|--help — prints the list of available commands and global options. Everything you put after it gets ignored, no cap.
• --version — prints the Buildbot and Twisted versions. Also ignores all subsequent commands. 👋
• --verbose — verbose output, so you see everything going on 🗣️

🧚 create-master command options

• -q|--quiet — do not emit the commands being run 🤫
• -f|--force — re-use a directory that already exists (heads up: it will not overwrite the master.cfg file)
• -r|--relocatable — creates a relocatable buildbot.tac 📦
• -n|--no-logrotate — does not permit the buildmaster to rotate logs by itself
• -c|--config — sets the name of the buildbot master config file to CONFIG. Default file name is master.cfg. 🌸
• -s|--log-size — sets the size at which the twisted log file is rotated to SIZE bytes. Default value is 1000000 bytes.
• -l|--log-count — limits the number of kept old twisted log files to COUNT. By default, all files are kept.
• --db — sets the database connection for storing scheduler/status state to DATABASE. Default value is sqlite:///state.sqlite. 🗄️
• PATH — directory where buildbot master files will be stored.

🍓 upgrade-master command options

• -q|--quiet — do not emit the commands being run.
• -r|--replace — replaces any modified files without confirmation. No take-backs, it's not gonna ask first.
• --db — sets the database connection for storing scheduler/status state to DATABASE. Default value is sqlite:///state.sqlite.
• PATH — directory where buildbot master files are stored.

💜 sendchange command options

• --master — sets the location of the buildmaster's PBChangeSource to attach to, in the form HOST:PORT.
• -u|--username — sets the committer's username to USERNAME.
• -R|--repository — sets the repository URL to REPOSITORY.
• -P|--project — sets the project specifier to PROJECT.
• -b|--branch — sets the branch name to BRANCH.
• -c|--category — sets the category of the repository to CATEGORY.
• -r|--revision — sets the revision being built to REVISION.
• --revision-file — uses the REVISIONFILE file to read revision spec data from.
• -p|--property — sets a property for the change to PROPERTY. It should be in the format NAME:VALUE.
• -m|--comments — sets the log message to MESSAGE.
• -F|--logfile — sets the logfile to LOGFILE.
• -w|--when — sets the timestamp used as the change time to TIMESTAMP. ⏰
• FILES — the list of files that have been changed.

🫶 try command options

• --wait — waits until the builds have finished. ⏳
• -n|--dry-run — gathers info, but does not actually submit anything.
• --get-builder-names — gets the names of the available builders. Doesn't submit anything. Only supported for 'pb' connections.
• -c|--connect — the connection type. Can be either 'ssh' or 'pb'.
• --tryhost — sets the hostname (used by ssh) for the buildmaster to HOSTNAME.
• --trydir — specifies the trydir (on the tryhost) where tryjobs are deposited.
• -m|--master — sets the location of the buildmaster's try scheduler in the form HOST:PORT.
• -u|--username — sets the username performing the trial build to USERNAME.
• --passwd — sets the password for PB authentication to PASSWORD. 🔐
• --diff — uses the DIFF file as a patch instead of scanning a local tree. Use '-' for stdin.
• --patchlevel — specifies the patchlevel to apply with. Defaults to 0. See patch for details.
• --baserev — uses the BASEREV revision instead of scanning a local tree.
• --vc — specifies the version control system in use. Possible values: cvs, svn, tla, baz, darcs, p4.
• --branch — specifies the branch in use, for VC systems that can't figure it out themselves. 😭
• -b|--builder — runs the trial build on the specified Builder. Can be used multiple times. 🔁
• --properties — specifies the set of properties made available in the build environment, in the format prop1=value1,prop2=value2...
• --try-topfile — specifies the name of a file at the top of the tree. This option is used to find the top. Only needed for SVN and CVS.
• --try-topdir — specifies the path to the top of the working copy. Only needed for SVN and CVS.

⭐ tryserver command options

• --jobdir — the jobdir (maildir) for submitting jobs 📬

🌸 FILES 🌸

• master.cfg — the Buildbot master configuration file. The one you keep editing. The one you keep breaking. Iconic. 💅

🌈 SEE ALSO 🌈

buildbot-worker(1), patch(1)

okay that's the whole page, every flag, every default, every PATH, all of it — nothing skipped, nothing invented, just vibes + facts 🫶

this was Buildbot, dated August 2010, living its life as BUILDBOT(1) — mwah, slay, periodt 💖✨🎀