README.md

ds-api-client

Step 1: Download (Linux or MacOS)

download

Step 2: Provide DS token

echo "GRAPHQL_TOKEN=<TOKEN>" >> .env

Step 3: Run

ds-api-client help dossier

Usage: ds-api-client dossier [options] <dossierNumber>

Display or download a dossier

Arguments:
  dossierNumber          Dossier number

Options:
  -d, --download         Download files
  -t, --table            Show dossier details
  -j, --json             Print dossier as JSON
  --no-color             No colors
  -P, --parallel <n>     Download in parallel <n> files (default: 20)
  -o, --outdir <outdir>  Output directory (default: "./data")
  -M, --messages         Download dossier messages
  -A, --avis             Download dossier avis
  -G, --geo              Download geo files
  --token <token>        API token
  -h, --help             display help for command

ds-api-client help dossiers

Usage: ds-api-client dossiers [options] <demarcheNumber>

List or download dossiers from a demarche

Arguments:
  demarcheNumber         Demarche number

Options:
  -f, --first <n>        Take first <n> dossiers
  -l, --last <n>         Take last <n> dossiers
  -a, --after <cursor>   After cursor
  -b, --before <cursor>  Before cursor
  -s, --since <date>     Dossiers updated since
  -d, --download         Download files
  -t, --table            Show dossier details
  -p, --paginate         Follow pagination
  -P, --parallel <n>     Download in parallel <n> files (default: 20)
  -o, --outdir <outdir>  Output directory (default: "./data")
  -c, --clean            Clean output directory
  -M, --messages         Download dossier messages
  -A, --avis             Download dossier avis
  -G, --geo              Download geo files
  --token <token>        API token
  -h, --help             display help for command

ds-api-client help demarche

Usage: ds-api-client demarche [options] <demarcheNumber>

Get demarche schema

Arguments:
  demarcheNumber   Demarche number

Options:
  --no-color       No colors
  -j, --json       Print schema as JSON
  --token <token>  API token
  -h, --help       display help for command