dcae-cli/README.md

   1 # dcae-cli
   2
   3 The `dcae-cli` is a Python command-line tool used to manage and to test components and their data formats in onboarding.
   4
   5 ## Documentation
   6
   7 Please review the [DCAE platform documentation](ONAP URL TBD) which has a detailed [`dcae-cli` walkthrough](ONAP URL TBD).
   8
   9 ## Local use
  10
  11 The dcae-cli requires access to an onboarding catalog which is a postgres database.  If there is no shared instance for your team or organization, then a workaround is to run a local instance of postgres on your machine.  One quick way is to run a postgres Docker container:
  12
  13 ```
  14 docker run -e POSTGRES_PASSWORD=<your password> -e PGDATA=/var/lib/postgresql/data/pgdata -v <local directory>:/var/lib/postgresql/data/pgdata -p 5432:5432 -d postgres:9.5.2
  15 ```
  16
  17 Use your favorite sql client to log into this local instance and create a database named `dcae_onboarding_db`.
  18
  19 Now that your onboarding catalog is setup, run `dcae_cli --reinit` and walkthrough the prompts to configure your dcae-cli to point to this local instance.