Skip to content

cg api puzzle

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

Every command also accepts -h / --help.

Command Summary
cg api puzzle Puzzle service commands.
cg api puzzle count-solved-puzzles-by-programming-language Count a codingamer's solved puzzles, broken down by programming language.
cg api puzzle find-puzzle-of-the-week Find the current puzzle of the week.
cg api puzzle find-all-minimal-progress Find a codingamer's minimal progress summary for every puzzle they have some relationship to.
cg api puzzle find-progress-by-ids Find a codingamer's progress summary for a specific set of puzzles, by puzzle ID.
cg api puzzle find-best-following-progress Find the best progress on a given puzzle among the codingamers a codingamer follows.
cg api puzzle find-progress-by-pretty-id Find a codingamer's progress summary for a single puzzle, by its pretty ID.
cg api puzzle generate-session-from-puzzle-pretty-id Get (or create) the codingamer's test session handle for a puzzle, by its pretty ID.

cg api puzzle

Puzzle service commands.

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

Subcommands

cg api puzzle count-solved-puzzles-by-programming-language

Count a codingamer's solved puzzles, broken down by programming language.

usage: cg api puzzle count-solved-puzzles-by-programming-language [-h] [--codingamer-id ID]

Options

  • -g, --codingamer-id ID — Codingamer whose solved-puzzle counts to list. Defaults to the logged-in codingamer's ID.

cg api puzzle find-puzzle-of-the-week

Find the current puzzle of the week.

usage: cg api puzzle find-puzzle-of-the-week [-h]

cg api puzzle find-all-minimal-progress

Find a codingamer's minimal progress summary for every puzzle they have some relationship to.

usage: cg api puzzle find-all-minimal-progress [-h] [--codingamer-id ID]

Options

  • -g, --codingamer-id ID — Codingamer whose puzzle progress to list. Defaults to the logged-in codingamer's ID.

cg api puzzle find-progress-by-ids

Find a codingamer's progress summary for a specific set of puzzles, by puzzle ID.

usage: cg api puzzle find-progress-by-ids [-h] [--codingamer-id ID] [--arg3 N]
                                          PUZZLE-ID [PUZZLE-ID ...]

Arguments

  • PUZZLE-ID [PUZZLE-ID ...] — One or more numeric puzzle IDs to look up.

Options

  • -g, --codingamer-id ID — Codingamer whose progress to look up. Defaults to the logged-in codingamer's ID.
  • --arg3 N (default: 2) — Third (purpose unclear) argument to the underlying API call. Defaults to 2.

cg api puzzle find-best-following-progress

Find the best progress on a given puzzle among the codingamers a codingamer follows.

usage: cg api puzzle find-best-following-progress [-h] [--codingamer-id ID] PUZZLE-ID

Arguments

  • PUZZLE-ID — Numeric ID of the puzzle to check.

Options

  • -g, --codingamer-id ID — Codingamer whose followees to check. Defaults to the logged-in codingamer's ID.

cg api puzzle find-progress-by-pretty-id

Find a codingamer's progress summary for a single puzzle, by its pretty ID.

usage: cg api puzzle find-progress-by-pretty-id [-h] [--codingamer-id ID] PRETTY-ID

Arguments

  • PRETTY-ID — The puzzle's pretty ID: displayed title, lowercased with spaces replaced by hyphens, e.g. 'literary-alfabet-soupe'.

Options

  • -g, --codingamer-id ID — Codingamer whose progress to look up. Defaults to the logged-in codingamer's ID.

cg api puzzle generate-session-from-puzzle-pretty-id

Get (or create) the codingamer's test session handle for a puzzle, by its pretty ID. Confirmed to return the same handle across repeated calls (a per-user singleton test session)--use cg api test-session start-test-session on the result to get the full session/question/answer details.

usage: cg api puzzle generate-session-from-puzzle-pretty-id [-h] [--codingamer-id ID]
                                                            PUZZLE-PRETTY-ID

Arguments

  • PUZZLE-PRETTY-ID — The puzzle's pretty ID: displayed title, lowercased with spaces replaced by hyphens, e.g. 'literary-alfabet-soupe'.

Options

  • -g, --codingamer-id ID — Codingamer to get/create the session for. Defaults to the logged-in codingamer's ID.

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