table of contents
other versions
MINI-BUILDD-TOOL(1) | User Commands | MINI-BUILDD-TOOL(1) |
NAME¶
mini-buildd-tool - User/client tool box for mini-buildd instances.
DESCRIPTION¶
usage: mini-buildd-tool [-h] [--version] [-v] [-q] [-J] [--auto-confirm]
- [--auto-save-passwords]
- ENDPOINT <cmd> [options] ...
Command line tool to run API calls.
positional arguments:¶
- ENDPOINT
- HTTP target endpoint: Twisted-style Network Client Endpoint.
- Notation Examples
- ----------------- '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 -- might eventually go away).
- May also be '[user@]DPUT_TARGET' for convenience
optional arguments:¶
- -h, --help
- show this help message and exit
- --version
- show program's version number and exit
- -v, --verbose
- increase log level. Give twice for max logs (default: 0)
- -q, --quiet
- decrease log level. Give twice for min logs (default: 0)
- -J, --json
- use parsable json output (default: False)
- --auto-confirm
- force-bypass extra confirmation (for confirmable commands) (default: False)
- --auto-save-passwords
- don't ask before saving passwords (via python-keyring) (default: False)
API commands (run 'mini-buildd-tool '' <cmd> --help' for full command help):¶
- <cmd> [options]
- status
- Show the status of the mini-buildd instance.
- 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
- Authorization: anonymous
- .
- start
- Start the Daemon (engine).
- 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
- Authorization: super user login
- .
- stop
- Stop the Daemon (engine).
- 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
- Authorization: super user login
- .
- getuploaders
- Get all GPG keys allowed to upload to repositories.
- JSON Result (dict): {repository: {'allow_unauthenticated_uploads': True|False, 'uploaders': {long_key_id: {key info...}), ..}}}
- Authorization: super user login
- .
- meta
- Call arbitrary meta functions for models; usually for internal use only. Authorization: super user login .
- autosetup
- Auto setup / bootstrap.
- Authorization: super user login
- .
- keyringpackages
- Build keyring packages for all active repositories.
- Authorization: super user login
- .
- testpackages
- Build internal test packages.
- Per default, we build all test packages for all active
- distributions ending on 'experimental'.
- Authorization: super user login
- .
- getkey
- Get GnuPG public key.
- JSON Result (dict):
- __plain__: string: ASCII-armored key.
- Authorization: anonymous
- .
- getdputconf
- Get recommended dput config snippet.
- Usually, this is for integration in your personal ~/.dput.cf.
- JSON Result (dict):
- __plain__: string: dput config snippet.
- Authorization: anonymous
- .
- getsourceslist
- Get sources.list (apt lines).
- Usually, this output is put to a file like '/etc/sources.list.d/mini-buildd-xyz.list'.
- JSON Result (dict):
- __plain__: string: apt lines
- Authorization: anonymous
- .
- logcat
- Cat last n lines of the mini-buildd's log.
- JSON Result (dict):
- __plain__: string: last n loglines
- Authorization: staff user login
- .
- list
- List packages matching a shell-like glob pattern; matches both source and binary package names.
- JSON Result (dict): {repository: [{package_info}...]}
- Authorization: any user login
- .
- show
- Show a source package.
- JSON Result (dict): {repository: [(codename, {package_info}),...]}
- Authorization: anonymous
- .
- find
- Find a source package.
- JSON Result (dict): {repository: [{package_info},...]}
- Authorization: anonymous
- .
- migrate
- Migrate a source package (along with all binary packages).
- JSON Result (dict):
- __plain__: string: textual migration log.
- Authorization: staff user login
- .
- remove
- Remove a source package (along with all binary packages).
- JSON Result (dict):
- __plain__: string: textual removal log.
- Authorization: super user login
- .
- port
- Port an internal package.
- An internal 'port' is a no-changes (i.e., only the changelog
- will be adapted) rebuild of the given locally-installed package.
- JSON Result (dict):
- requested: list: Info string about each port that has been triggered
- Authorization: staff user login
- .
- portext
- Port an external package.
- An external 'port' is a no-changes (i.e., only the changelog
- will be adapted) rebuild of any given source package.
- JSON Result (dict):
- requested: list: Info string about each port that has been triggered.
- Authorization: staff user login
- .
- retry
- Retry a previously failed package.
- JSON Result (dict):
- requested: string: Info string about each retry that has been triggered.
- Authorization: staff user login
- .
- setuserkey
- Set a user's GnuPG public key.
- Authorization: any user login
- .
- subscription
- Manage subscriptions to package notifications.
- A package subscription is a tuple 'PACKAGE:DISTRIBUTION',
- where both PACKAGE or DISTRIBUTION may be empty to denote all resp. items.
- 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.
- Authorization: any user login
- .
Note: Uses 'python-keyring' to persist passwords (see '~/.local/share/python_keyring/')
May 2020 | mini-buildd-tool 1.1.28 |