.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
.TH MINI-BUILDD-TOOL "1" "May 2020" "mini-buildd-tool 1.1.28" "User Commands"
.SH NAME
mini-buildd-tool \- User/client tool box for mini-buildd instances.
.SH DESCRIPTION
usage: mini\-buildd\-tool [\-h] [\-\-version] [\-v] [\-q] [\-J] [\-\-auto\-confirm]
.TP
[\-\-auto\-save\-passwords]
ENDPOINT <cmd> [options] ...
.PP
Command line tool to run API calls.
.SS "positional arguments:"
.TP
ENDPOINT
HTTP target endpoint: Twisted\-style Network Client Endpoint.
.IP
See: https://twistedmatrix.com/documents/current/core/howto/endpoints.html#clients
.TP
Notation Examples
\fB\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\fR
\&'tcp:host=localhost:port=8066': Connect to localhost, unencrypted.
\&'tls:host=localhost:port=8066': Connect to localhost, encrypted.
\&'http://localhost:8066'       : Extra URL\-style syntax (prefer twisted\-style in saved configs, though).
\&'localhost:8066'              : Compatibility host:port syntax (don't use \fB\-\-\fR might eventually go away).
.IP
May also be '[user@]DPUT_TARGET' for convenience
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
increase log level. Give twice for max logs (default: 0)
.TP
\fB\-q\fR, \fB\-\-quiet\fR
decrease log level. Give twice for min logs (default: 0)
.TP
\fB\-J\fR, \fB\-\-json\fR
use parsable json output (default: False)
.TP
\fB\-\-auto\-confirm\fR
force\-bypass extra confirmation (for confirmable commands) (default: False)
.TP
\fB\-\-auto\-save\-passwords\fR
don't ask before saving passwords (via python\-keyring) (default: False)
.SS "API commands (run 'mini-buildd-tool '' <cmd> --help' for full command help):"
.IP
<cmd> [options]
.TP
status
Show the status of the mini\-buildd instance.
.TP
JSON Result (dict):
identity    : string: instance identity
version     : string: mini\-buildd version
http        : string: HTTP URL
ftp         : string: FTP URL
running     : bool: Whether instance is accepting incoming
load        : float: machine load (0 =< load <= 1+)
chroots     : dict: {codename: [arch, ..]}: Active chroots
repositories: dict: {identity: [codename, ..]}: Active repositories
remotes     : list: Active or auto\-reactivate remotes
packaging   : list: Active (source) packages being processed
building    : list: Active (binary) package builds
.TP
Authorization: anonymous
\&.
.TP
start
Start the Daemon (engine).
.TP
JSON Result (dict):
identity    : string: instance identity
version     : string: mini\-buildd version
http        : string: HTTP URL
ftp         : string: FTP URL
running     : bool: Whether instance is accepting incoming
load        : float: machine load (0 =< load <= 1+)
chroots     : dict: {codename: [arch, ..]}: Active chroots
repositories: dict: {identity: [codename, ..]}: Active repositories
remotes     : list: Active or auto\-reactivate remotes
packaging   : list: Active (source) packages being processed
building    : list: Active (binary) package builds
.TP
Authorization: super user login
\&.
.TP
stop
Stop the Daemon (engine).
.TP
JSON Result (dict):
identity    : string: instance identity
version     : string: mini\-buildd version
http        : string: HTTP URL
ftp         : string: FTP URL
running     : bool: Whether instance is accepting incoming
load        : float: machine load (0 =< load <= 1+)
chroots     : dict: {codename: [arch, ..]}: Active chroots
repositories: dict: {identity: [codename, ..]}: Active repositories
remotes     : list: Active or auto\-reactivate remotes
packaging   : list: Active (source) packages being processed
building    : list: Active (binary) package builds
.TP
Authorization: super user login
\&.
.TP
getuploaders
Get all GPG keys allowed to upload to repositories.
.IP
JSON Result (dict): {repository: {'allow_unauthenticated_uploads': True|False, 'uploaders': {long_key_id: {key info...}), ..}}}
.TP
Authorization: super user login
\&.
.TP
meta
Call arbitrary meta functions for models; usually for internal use only.
Authorization: super user login
\&.
.TP
autosetup
Auto setup / bootstrap.
.TP
Authorization: super user login
\&.
.TP
keyringpackages
Build keyring packages for all active repositories.
.TP
Authorization: super user login
\&.
.TP
testpackages
Build internal test packages.
.TP
Per default, we build all test packages for all active
distributions ending on 'experimental'.
.TP
Authorization: super user login
\&.
.TP
getkey
Get GnuPG public key.
.TP
JSON Result (dict):
__plain__: string: ASCII\-armored key.
.TP
Authorization: anonymous
\&.
.TP
getdputconf
Get recommended dput config snippet.
.IP
Usually, this is for integration in your personal ~/.dput.cf.
.TP
JSON Result (dict):
__plain__: string: dput config snippet.
.TP
Authorization: anonymous
\&.
.TP
getsourceslist
Get sources.list (apt lines).
.IP
Usually, this output is put to a file like '/etc/sources.list.d/mini\-buildd\-xyz.list'.
.TP
JSON Result (dict):
__plain__: string: apt lines
.TP
Authorization: anonymous
\&.
.TP
logcat
Cat last n lines of the mini\-buildd's log.
.TP
JSON Result (dict):
__plain__: string: last n loglines
.TP
Authorization: staff user login
\&.
.TP
list
List packages matching a shell\-like glob pattern; matches both source and binary package names.
.IP
JSON Result (dict): {repository: [{package_info}...]}
.TP
Authorization: any user login
\&.
.TP
show
Show a source package.
.IP
JSON Result (dict): {repository: [(codename, {package_info}),...]}
.TP
Authorization: anonymous
\&.
.TP
find
Find a source package.
.IP
JSON Result (dict): {repository: [{package_info},...]}
.TP
Authorization: anonymous
\&.
.TP
migrate
Migrate a source package (along with all binary packages).
.TP
JSON Result (dict):
__plain__: string: textual migration log.
.TP
Authorization: staff user login
\&.
.TP
remove
Remove a source package (along with all binary packages).
.TP
JSON Result (dict):
__plain__: string: textual removal log.
.TP
Authorization: super user login
\&.
.TP
port
Port an internal package.
.TP
An internal 'port' is a no\-changes (i.e., only the changelog
will be adapted) rebuild of the given locally\-installed
package.
.TP
JSON Result (dict):
requested: list: Info string about each port that has been triggered
.TP
Authorization: staff user login
\&.
.TP
portext
Port an external package.
.TP
An external 'port' is a no\-changes (i.e., only the changelog
will be adapted) rebuild of any given source package.
.TP
JSON Result (dict):
requested: list: Info string about each port that has been triggered.
.TP
Authorization: staff user login
\&.
.TP
retry
Retry a previously failed package.
.TP
JSON Result (dict):
requested: string: Info string about each retry that has been triggered.
.TP
Authorization: staff user login
\&.
.TP
setuserkey
Set a user's GnuPG public key.
.TP
Authorization: any user login
\&.
.TP
subscription
Manage subscriptions to package notifications.
.TP
A package subscription is a tuple 'PACKAGE:DISTRIBUTION',
where both PACKAGE or DISTRIBUTION may be empty to denote
all resp. items.
.TP
JSON Result (dict):
list: list: (action=list only) Human readable list of subscriptions.
add: list: (action=add only) Human readable list of added subscriptions.
remove: list: (action=lremoved only) Human readable list of removed subscriptions.
.TP
Authorization: any user login
\&.
.PP
Note: Uses 'python\-keyring' to persist passwords (see '~/.local/share/python_keyring/')