pinspect - repository inspection interface

Synopsis

pinspect [-h] [–version] [–debug] [-q] [-v] [–color BOOLEAN] [–config CONFIG_PATH] {pkgsets,eapi_usage,license_usage,eclass_usage,mirror_usage,distfiles_usage,query,portageq,profile,digests} …

Description

pinspect is used to extract various information from repos. For example, it can perform aggregated EAPI, license, eclass, and mirror usage queries across specified repos. Any repo type can be queried, e.g. ebuild, binary, or vdb.

It also provides an interface to all profile specific metadata, e.g. package masks, inheritance trees, etc. This makes it easier to inspect profile differences without sorting through the inheritance tree and reading the raw files.

Finally, a portageq compatible interface is provided for several commands that were historically used in ebuilds.

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--version

Show this program’s version information and exit.

When running from within a git repo or a version installed from git the latest commit hash and date will be shown.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

Config Options

--config CONFIG_PATH

The path to a custom pkgcore config file or portage config directory can be given to override loading the default system config.

Alternatively, an argument of ‘false’ or ‘no’ will skip loading the system config entirely if one exists.

Subcommands

report applets

pinspect eapi_usage - report of eapi usage for targeted repos

Synopsis

pinspect eapi_usage [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–no-final-summary] [–sort-by-name] [–first FIRST | –last LAST] [repo …]

Positional Arguments

repo

repo(s) to inspect

Options

--no-final-summary

disable outputting a summary of data across all repos

--sort-by-name

sort output by name, rather then by frequency

--first FIRST

show only the first N detail items

--last LAST

show only the last N detail items

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect license_usage - report of license usage for targeted repos

Synopsis

pinspect license_usage [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–no-final-summary] [–sort-by-name] [–first FIRST | –last LAST] [repo …]

Positional Arguments

repo

repo(s) to inspect

Options

--no-final-summary

disable outputting a summary of data across all repos

--sort-by-name

sort output by name, rather then by frequency

--first FIRST

show only the first N detail items

--last LAST

show only the last N detail items

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect eclass_usage - report of eclass usage for targeted repos

Synopsis

pinspect eclass_usage [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–no-final-summary] [–sort-by-name] [–first FIRST | –last LAST] [repo …]

Positional Arguments

repo

repo(s) to inspect

Options

--no-final-summary

disable outputting a summary of data across all repos

--sort-by-name

sort output by name, rather then by frequency

--first FIRST

show only the first N detail items

--last LAST

show only the last N detail items

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect mirror_usage - report of SRC_URI mirror usage for targeted repos

Synopsis

pinspect mirror_usage [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–no-final-summary] [–sort-by-name] [–first FIRST | –last LAST] [repo …]

Positional Arguments

repo

repo(s) to inspect

Options

--no-final-summary

disable outputting a summary of data across all repos

--sort-by-name

sort output by name, rather then by frequency

--first FIRST

show only the first N detail items

--last LAST

show only the last N detail items

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect distfiles_usage - report detailing distfiles space usage for targeted repos

Synopsis

pinspect distfiles_usage [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–no-final-summary | –no-repo-summary | –no-detail] [–sort-by-name] [–first FIRST | –last LAST] [–include-nonmirrored] [–include-restricted] [repo …]

Positional Arguments

repo

repo(s) to inspect

Options

--no-final-summary

disable outputting a summary of data across all repos

--no-repo-summary

disable outputting repo summaries

--no-detail

disable outputting a detail view of all repos

--sort-by-name

sort output by name, rather then by frequency

--first FIRST

show only the first N detail items

--last LAST

show only the last N detail items

--include-nonmirrored

if set, nonmirrored distfiles will be included in the total

--include-restricted

if set, fetch restricted distfiles will be included in the total

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query - auxiliary access to ebuild/repo info via portageq akin api

Synopsis

pinspect query [-h] [–debug] [-q] [-v] [–color BOOLEAN] {best_version,env_var,get_profiles,get_repo_path,get_repos,has_version,mass_best_version} …

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

Subcommands

query commands

pinspect query best_version - Return the maximum visible version for a given atom.
Synopsis

pinspect query best_version [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN] atom

Positional Arguments
atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query env_var - return configuration defined variables.
Synopsis

pinspect query env_var [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN] variable [variable …]

Positional Arguments
variable

variable to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query get_profiles
Synopsis

pinspect query get_profiles [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN] repo_id

Positional Arguments
repo_id

repo_id to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query get_repo_path
Synopsis

pinspect query get_repo_path [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN] repo_id

Positional Arguments
repo_id

repo_id to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query get_repos
Synopsis

pinspect query get_repos [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN]

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query has_version - Return 0 if an atom is merged, 1 if not.
Synopsis

pinspect query has_version [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN] atom

Positional Arguments
atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect query mass_best_version - multiple best_version calls.
Synopsis

pinspect query mass_best_version [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [–domain DOMAIN | –domain-at-root DOMAIN] atom [atom …]

Positional Arguments
atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

--domain DOMAIN

custom pkgcore domain to use for this operation

--domain-at-root DOMAIN

specify the domain to use via its root path

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq - portageq compatible interface to query commands

Synopsis

pinspect portageq [-h] [–debug] [-q] [-v] [–color BOOLEAN] {best_version,envvar,envvar2,get_repo_news_path,get_repo_path,get_repos,has_version,mass_best_version,match} …

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

Subcommands

portageq commands

pinspect portageq best_version - Return the maximum visible version for a given atom.
Synopsis

pinspect portageq best_version [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root atom

Positional Arguments
root

the domain that lives at root will be used

atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq envvar - return configuration defined variables. Use envvar2 instead, this will be removed.
Synopsis

pinspect portageq envvar [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [root] variable [variable …]

Positional Arguments
root

the domain that lives at root will be used

variable

variable to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq envvar2 - return configuration defined variables.
Synopsis

pinspect portageq envvar2 [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root variable [variable …]

Positional Arguments
root

the domain that lives at root will be used

variable

variable to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq get_repo_news_path
Synopsis

pinspect portageq get_repo_news_path [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root repo_id

Positional Arguments
root

the domain that lives at root will be used

repo_id

repo_id to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq get_repo_path
Synopsis

pinspect portageq get_repo_path [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root repo_id

Positional Arguments
root

the domain that lives at root will be used

repo_id

repo_id to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq get_repos
Synopsis

pinspect portageq get_repos [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] [root]

Positional Arguments
root

the domain that lives at root will be used

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq has_version - Return 0 if an atom is merged, 1 if not.
Synopsis

pinspect portageq has_version [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root atom

Positional Arguments
root

the domain that lives at root will be used

atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq mass_best_version - multiple best_version calls.
Synopsis

pinspect portageq mass_best_version [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root atom [atom …]

Positional Arguments
root

the domain that lives at root will be used

atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect portageq match - shorthand for pquery –installed
Synopsis

pinspect portageq match [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–eapi ATOM_KLS] [–use USE] root atom

Positional Arguments
root

the domain that lives at root will be used

atom

atom to inspect

Options
--eapi ATOM_KLS

limit all operations to just what the given EAPI supports.

--use USE

override the use flags used for transititive USE deps- dev-lang/python[threads=] for example

Base Options
-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

pinspect digests - identify what packages are missing digest info

Synopsis

pinspect digests [-h] [–debug] [-q] [-v] [–color BOOLEAN] [–domain DOMAIN] [repos …]

Positional Arguments

repos

repo to inspect

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

Config Options

--domain DOMAIN

custom pkgcore domain to use for this operation