Skip to content

cg api search

The search service endpoint. See cg api for how these relate to the higher-level commands.

Every command also accepts -h / --help.

Command Summary
cg api search Search service commands.
cg api search search Search for codingamers, puzzles, and other objects by name.

cg api search

Search service commands.

usage: cg api search [-h] COMMAND ...

Subcommands

  • search — Search for codingamers, puzzles, and other objects by name.

Search for codingamers, puzzles, and other objects by name.

usage: cg api search search [-h] [--locale LOCALE] [--type TYPE] QUERY

Arguments

  • QUERY — Search query text, e.g. a codingamer's pseudo or part of a puzzle title.

Options

  • -l, --locale LOCALE (default: en) — Locale code for localized result names, e.g. 'en', 'fr'. Defaults to 'en'.
  • -t, --type TYPE — Restrict results to a single result type, e.g. 'USER', 'PUZZLE'. Defaults to no filter (all types).

Generated from the parser itself. For when to use these, see the CLI guides.