Skip to content

Generated CLI command reference (unreleased)

Generated from Typer's public help entrypoints during this build.

rpkiparrot

 Usage: rpkiparrot [OPTIONS] COMMAND [ARGS]...                                  

 RPKI payload queries and validation. Choose an explicit input source.          

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json-file                        <path>                                    │
│ --snapshot                         <path>                                    │
│ --json-format                      <str>    [default: auto]                  │
│ --max-age                          <float>                                   │
│ --valid-until                      <str>                                     │
│ --at                               <str>                                     │
│ --config                           <path>   [env var: RPKIPARROT_CONFIG]     │
│ --database                         <path>   Observe an existing SQLite       │
│                                             database read-only.              │
│ --remote                           <str>    Query an existing HTTP service.  │
│ --remote-token-env                 <str>    Explicit bearer-token            │
│                                             environment variable name.       │
│ --remote-ca-file                   <path>   CA file for remote HTTPS         │
│                                             certificate verification.        │
│ --rtr                              <str>                                     │
│ --tls                                                                        │
│ --ssh                                       Use the SSH rpki-rtr subsystem;  │
│                                             requires the ssh extra.          │
│ --ssh-user                         <str>    SSH user name.                   │
│ --ssh-known-hosts                  <path>   Required OpenSSH known-hosts     │
│                                             file.                            │
│ --ssh-key                          <path>   Explicit SSH private-key file;   │
│                                             may be repeated.                 │
│ --ssh-password-env                 <str>    Environment variable holding the │
│                                             SSH password.                    │
│ --ssh-passphrase-env               <str>    Environment variable holding the │
│                                             key passphrase.                  │
│ --server-name                      <str>                                     │
│ --ca-file                          <path>                                    │
│ --client-cert-file                 <path>                                    │
│ --client-key-file                  <path>                                    │
│ --trust-profile-id                 <str>                                     │
│ --local-address                    <str>                                     │
│ --min-version                      <int>    [default: 1]                     │
│ --max-version                      <int>    [default: 1]                     │
│ --v2-profile                       <str>    [default: 8210bis-27]            │
│ --format                           <str>    [env var: RPKIPARROT_FORMAT]     │
│ --timeout                          <float>  Request/readiness seconds;       │
│                                             defaults to 180 for remote mode, │
│                                             30 otherwise.                    │
│                                             [env var: RPKIPARROT_TIMEOUT]    │
│ --no-color              --color             [env var: RPKIPARROT_NO_COLOR]   │
│ --log-level                        <str>    [env var: RPKIPARROT_LOG_LEVEL]  │
│ --quiet                                                                      │
│ --verbose                                                                    │
│ --version                                                                    │
│ --install-completion                        Install completion for the       │
│                                             current shell.                   │
│ --show-completion                           Show completion for the current  │
│                                             shell, to copy it or customize   │
│                                             the installation.                │
│ --help                                      Show this message and exit.      │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ export    Export a complete snapshot; file output is atomic and requires     │
│           explicit overwrite.                                                │
│ sync      Wait for required payloads once, or keep the owned client running  │
│           with --watch.                                                      │
│ status    Sample this command's own client; an explicit --required waits for │
│           readiness.                                                         │
│ watch     Emit a complete initial view and bounded events; explicitly        │
│           recover event loss.                                                │
│ serve     Serve the explicit --config with one HTTP owner and bounded        │
│           requests.                                                          │
│ record    Record one RTR session to a new file, for 60 seconds or an         │
│           explicit duration.                                                 │
│ replay    Replay a selected trace offline at an explicit --at UTC timestamp. │
│ validate                                                                     │
│ query                                                                        │
│ analyze                                                                      │
│ sources                                                                      │
│ config                                                                       │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot config check

 Usage: rpkiparrot config check [OPTIONS]                                       

 Validate configuration and prepare dependencies without starting source        
 networking.                                                                    

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot sync

 Usage: rpkiparrot sync [OPTIONS]                                               

 Wait for required payloads once, or keep the owned client running with         
 --watch.                                                                       

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --required        <str>                                                      │
│ --watch                                                                      │
│ --backend         <str>                                                      │
│ --db-path         <path>                                                     │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot status

 Usage: rpkiparrot status [OPTIONS]                                             

 Sample this command's own client; an explicit --required waits for readiness.  

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --required        <str>                                                      │
│ --help                   Show this message and exit.                         │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot watch

 Usage: rpkiparrot watch [OPTIONS]                                              

 Emit a complete initial view and bounded events; explicitly recover event      
 loss.                                                                          

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --required        <str>                                                      │
│ --help                   Show this message and exit.                         │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot validate origin

 Usage: rpkiparrot validate origin [OPTIONS] [prefix] [asn]                     

 Validate PREFIX ASN (or none), or one bounded JSONL input batch.               

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│   prefix      <str>                                                          │
│   asn         <str>                                                          │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --input          <str>                                                       │
│ --explain                                                                    │
│ --help                  Show this message and exit.                          │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot validate aspa

 Usage: rpkiparrot validate aspa [OPTIONS]                                      

 Apply the fixed experimental ASPA algorithm with explicit receiving context.   

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --path                <str>                                                  │
│ --local-asn           <int>                                                  │
│ --neighbor-asn        <int>                                                  │
│ --relationship        <str>                                                  │
│ --afi                 <str>                                                  │
│ --input               <str>                                                  │
│ --explain                                                                    │
│ --help                       Show this message and exit.                     │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot query vrps

 Usage: rpkiparrot query vrps [OPTIONS]                                         

 Query covering or filtered effective VRPs from one fixed snapshot.             

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --covering         <str>                                                     │
│ --asn              <int>                                                     │
│ --source-id        <str>                                                     │
│ --family           <int>                                                     │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot query aspa

 Usage: rpkiparrot query aspa [OPTIONS] [customer]                              

 Query a customer or traverse effective customer/provider unions.               

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│   customer      <int>                                                        │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --all                                                                        │
│ --afi              <str>                                                     │
│ --source-id        <str>                                                     │
│ --help                    Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot analyze bmp

 Usage: rpkiparrot analyze bmp [OPTIONS]                                        

 Analyze explicit BMP context without turning absent evidence into valid.       

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ *  --input          <str>  [required]                                        │
│    --afi            <str>                                                    │
│    --explain                                                                 │
│    --help                  Show this message and exit.                       │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot sources diff

 Usage: rpkiparrot sources diff [OPTIONS] {left} {right}                        

 Compare original source support without choosing which source to trust.        

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    left       <str>  [required]                                            │
│ *    right      <str>  [required]                                            │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot export

 Usage: rpkiparrot export [OPTIONS]                                             

 Export a complete snapshot; file output is atomic and requires explicit        
 overwrite.                                                                     

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output        <str>  [default: -]                                          │
│ --force                                                                      │
│ --help                 Show this message and exit.                           │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot serve

 Usage: rpkiparrot serve [OPTIONS]                                              

 Serve the explicit --config with one HTTP owner and bounded requests.          

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --host        <str>                                                          │
│ --port        <int>                                                          │
│ --help               Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot record

 Usage: rpkiparrot record [OPTIONS]                                             

 Record one RTR session to a new file, for 60 seconds or an explicit duration.  

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ *  --output           <path>   [required]                                    │
│    --duration         <float>                                                │
│    --watch                                                                   │
│    --source-id        <str>                                                  │
│    --help                      Show this message and exit.                   │
╰──────────────────────────────────────────────────────────────────────────────╯

rpkiparrot replay

 Usage: rpkiparrot replay [OPTIONS] {path}                                      

 Replay a selected trace offline at an explicit --at UTC timestamp.             

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    path      <path>  [required]                                            │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --at                      <str>                                              │
│ --allow-incomplete                                                           │
│ --max-events              <int>  [default: 10000]                            │
│ --max-report-bytes        <int>  [default: 16777216]                         │
│ --help                           Show this message and exit.                 │
╰──────────────────────────────────────────────────────────────────────────────╯