Program

The gpp program command group provides access to program operations.

Quick Example

Get a program:

gpp program get --program-id p-123

List programs:

gpp program list --limit 10

Selecting Programs

The get command requires exactly one selector:

  • --program-id

  • --program-reference

  • --proposal-reference

Warning

Provide exactly one selector.

Reference

gpp program

 gpp program Usage: gpp program [OPTIONS] COMMAND [ARGS]... Program operations. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────╮ │get Get a program using exactly one selector.                             │ │listList programs.                                                        │ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp program get

 gpp program get Usage: gpp program get [OPTIONS] Get a program using exactly one selector. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--program-idTEXTGet a program by ID.│ │--program-referenceTEXTGet a program by reference.│ │--proposal-referenceTEXTGet a program by proposal reference.│ │--include-deletedInclude deleted related records.│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

gpp program list

 gpp program list Usage: gpp program list [OPTIONS] List programs. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--include-deletedInclude deleted programs.│ │--offsetTEXT                Pagination offset.│ │--limitINTEGER RANGE [x>=1]Maximum number of programs to│ │return.                      │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯

See also: Program