Skip to content

Conversation

@znarfm
Copy link
Collaborator

@znarfm znarfm commented Nov 27, 2025

Checklist

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):
  • Reference issue: Let's document: poetry #18042

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Nov 27, 2025
@znarfm znarfm mentioned this pull request Nov 27, 2025
28 tasks
Comment on lines +7 to +13
- Search for a package:

`poetry search {{package_name}}`

- Search for multiple packages:

`poetry search {{package1 package2 ...}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If searching the PyPI always fails (like pip search), then add an option to specify a custom index. It doesn't make sense to have examples that don't work.

Like in here:

- Search for packages using a custom package index:
`pip search {{[-i|--index]}} {{example.com}} {{query}}`

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

poetry search does not seem provide a way to modify where to search

> poetry search --help

Description:
  Searches for packages on remote repositories.

Usage:
  search [options] [--] <tokens>...

Arguments:
  tokens                     The tokens to search for.

Options:
  -h, --help                 Display help for the given command. When no command is given display help for the list command.
  -q, --quiet                Do not output any message.
  -V, --version              Display this application version.
      --ansi                 Force ANSI output.
      --no-ansi              Disable ANSI output.
  -n, --no-interaction       Do not ask any interactive question.
      --no-plugins           Disables plugins.
      --no-cache             Disables Poetry source caches.
  -P, --project=PROJECT      Specify another path as the project root. All command-line arguments will be resolved relative to the current working directory.
  -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory). All command-line arguments will be resolved relative to the given directory.
  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.

Also, as said in #18042 (comment), searching seem to work fine for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants