deleted compy of help docu and provided short instructions

Author: ElJocho

docs/source/cli.md

@@ -1,10 +1,10 @@
 # Command Line Interface
 
-THIS DOCUMENT IS OUTDATED: Please use the `--help` flag of the CLI.
+The Mapswipe Backend provides a Command Line Interface(CLI) with which the users can interact with the program.
+They can be used for example to create projects, which were uploaded to the [manager-dashboard](for_mapswipe_managers.html),
+or to export statistics on the finished projects. To get a comprehensible lists of the available commands use the ```--help``` flag.
 
----
-
-This document describes how to use the command line interface of MapSwipe Worker.
+```mapswipe_workers --help``` would get you all possible commands, while e.g. ```mapswipe_workers archive --help``` would get you additional information on how to use that command.
 
 In our current deployment setup the commands of the MapSwipe Workers CLI are hard-coded in the Docker-Compose File.
 
@@ -13,148 +13,3 @@ You can run these commands also using docker-compose:
 ```
 docker-compose run mapswipe_workers mapswipe_workers --help
 ```
-
-
-```
-Usage: mapswipe_workers [OPTIONS] COMMAND [ARGS]...
-
-Options:
-  -v, --verbose
-  --version      Show the version and exit.
-  --help         Show this message and exit.
-
-Commands:
-  create-projects
-  create-tutorial
-  firebase-to-postgres
-  generate-stats
-  run
-  user-management
-```
-
-
-## Create projects from submitted project drafts
-
-```
-Usage: mapswipe_workers create-projects [OPTIONS]
-
-Options:
-  -s, --schedule [m|h|d]  Will create projects every 10 minutes (m), every
-                          hour (h) or every day (d).
-  --help                  Show this message and exit.
-```
-
-
-## Transfer data from Firebase to Postgres
-
-```
-Usage: mapswipe_workers firebase-to-postgres [OPTIONS]
-
-Options:
-  -s, --schedule [m|h|d]  Will update and transfer relevant data (i.a. users
-                          and results) from Firebase into Postgres every 10
-                          minutes (m), every hour (h) or every day (d).
-  --help                  Show this message and exit.
-```
-
-
-## Generate Statistics
-
-```
-Usage: mapswipe_workers generate-stats [OPTIONS]
-
-Options:
-  -s, --schedule [m|h|d]  Generate stats every 10 minutes (m), every hour (h)
-                          or every day (d).
-  --project_id_list TEXT  provide project id strings as a list stats will be
-                          generated only for these projects.
-                          Use it like '["project_a", "project_b"]'
-  --help                  Show this message and exit.
-```
-
-## Generate Statistics for all projects
-
-Ideally you run this using a separate docker container. e.g. like this:
-
-```
-docker-compose run mapswipe_workers mapswipe_workers generate-stats-all-projects
-```
-
-```
-Usage: mapswipe_workers generate-stats-all-projects [OPTIONS]
-
-Options:
-  -s, --schedule [m|h|d]  Generate stats every 10 minutes (m), every hour (h)
-                          or every day (d).
-  --help                  Show this message and exit.
-```
-
-## User Management
-
-```
-Usage: mapswipe_workers user-management [OPTIONS]
-
-Options:
-  --email TEXT       The email of the MapSwipe user.  [required]
-  --manager BOOLEAN  Set option to grant or remove project manager
-                     credentials. Use true to grant credentials. Use false to
-                     remove credentials.
-  --help             Show this message and exit.
-```
-
-## Archive Projects
-
-```
-Usage: mapswipe_workers archive [OPTIONS]
-
-  Archive projects in Postgres. Delete groups, tasks and results from
-  Firebase.
-
-Options:
-  -i, --project-id TEXT  Archive project with giving project id
-  --project-ids TEXT     Archive multiple projects. Provide project id strings
-                         as a list: '["project_a", "project_b"]'
-
-  --help                 Show this message and exit.
-
-```
-
-You can get the project ids for the projects to be archive either from the manager dashboard or query directly in postgres. For example:
-
-```
-SELECT project_id
-FROM projects
-WHERE status = 'finished' AND created < '2020-09-01'
-```
-
-## Delete Projects
-
-```
-Usage: mapswipe_workers delete [OPTIONS]
-
-  Delete tasks, groups, project and results.
-
-Options:
-  -i, --project-id TEXT  Delete project with giving project id
-  --project-ids TEXT     Delete multiple projects. Provide project id strings
-                         as a list: '["project_a", "project_b"]'
-
-  --help                 Show this message and exit.
-```
-
-
-## Create Tutorial from json file (e.g. provided in sample data)
-
-```
-Usage: mapswipe_workers create-tutorial [OPTIONS]
-
-Options:
-  --input_file TEXT  The json file with your tutorial information.  [required]
-  --help             Show this message and exit.
-
-```
-
-## Run a script which requires mapswipe_workers library
-```
-docker-compose run mapswipe_workers python3 python_scripts/add_project_geometries_to_api.py
-```