LinuxCommandLibrary

poetry-list

List Poetry CLI commands

TLDR

List all available Poetry commands

$ poetry list
copy

List commands for a specific namespace
$ poetry list [namespace]
copy

SYNOPSIS

poetry list [options]

PARAMETERS

-h, --help
    Displays help for the given command, showing its specific options and usage.

-q, --quiet
    Do not output any message, suppressing all non-error output from the command.

-v, --verbose (-vv, -vvv)
    Increases the verbosity of messages. -v for normal output, -vv for more verbose output, and -vvv for debug information.

--version
    Displays the Poetry application version that is currently in use.

--ansi
    Forces ANSI output, enabling colored text and formatting even if it's not detected automatically.

--no-ansi
    Disables ANSI output, removing colored text and special formatting.

--no-interaction
    Do not ask any interactive question, useful for scripting or automated environments.

-e, --env <ENV>
    Specifies the environment name to work with (e.g., python3.9 or a custom virtual environment name).

DESCRIPTION

poetry list is a foundational subcommand within the Poetry dependency management tool for Python. Its primary function is to display a comprehensive catalog of all available Poetry commands, each accompanied by a brief, descriptive summary. This command serves as an essential reference for users, enabling them to quickly discover, explore, and recall the various functionalities offered by the Poetry CLI.

From managing project dependencies and virtual environments to publishing packages, poetry list provides a bird's-eye view of the tool's capabilities, making it easier for both new and experienced users to navigate and utilize Poetry effectively. It's often the first command consulted when seeking to understand what actions Poetry can perform or to get an overview of the CLI's scope.

CAVEATS

Since poetry list is part of the Poetry ecosystem, it requires Poetry to be installed and accessible in the system's PATH. It only lists commands available in the current Poetry version and configuration; it does not list standard system commands or commands from other tools. While it displays global Poetry commands, its behavior and output are generally consistent regardless of the current working directory.

GLOBAL OPTIONS

Many of the options like --help, --quiet, --verbose, --no-interaction, and --env are global options that apply to most Poetry commands, not exclusively to poetry list. They control aspects like output verbosity, interactive prompts, and environment selection across various Poetry operations.

USAGE CONTEXT

While poetry list can be run from any directory, its output is consistent regardless of whether it's executed within a Poetry project or not, as it lists the global Poetry commands available to the user. This means the list of commands itself doesn't change based on project context, only the availability of certain context-dependent operations might.

HISTORY

Poetry was created by Sébastien Eustace and first released in 2017, aiming to provide a more consistent and robust dependency management and packaging solution for Python projects. The poetry list command has been a fundamental component of the CLI from its early versions. It serves as a primary entry point for users to explore the tool's capabilities, reflecting common patterns in modern CLI tools where `list` or `help` commands provide an overview of available subcommands.

SEE ALSO

poetry help(1), poetry install(1), poetry show(1), man(1)

Copied to clipboard