EarthScope / rover

ROVER: robust data access tool for FDSN data centers
https://earthscope.github.io/rover/
Other
10 stars 1 forks source link

Hide daemon mode features from user #90

Closed chad-earthscope closed 5 years ago

chad-earthscope commented 5 years ago

The daemon mode, with all related features, should be hidden from the user for now. In the future, we may re-expose or remove this code.

The following commands should be removed or hidden from the current help help output (or wherever that ends up):

             daemon: The background daemon (prefer start/stop)
     list-subscribe: List the subscriptions
              start: Start the background daemon
             status: Show the background daemon status
               stop: Stop the background daemon
          subscribe: Add a subscription
            trigger: Ask the daemon to reprocess subscriptions

These commands should be moved to and advanced/low-level section and not be exposed on a main list of commands:

           download: Download data from a remote service
              index: Index the repository
             ingest: Ingest data from a file into the repository
                web: Start a web server showing status
  retrieve-metadata: Download missing metadata

Which leaves the important commands as (which need to be ordered by importance):

    init-repository: Create / configure the repository
           retrieve: Download, ingest and index missing data
         list-index: List the contents of the repository
      list-retrieve: Show what data "rover retrieve" will download
       list-summary: List a summary of the repository
            summary: Update summary table
chad-earthscope commented 5 years ago

Hi @timronan, we also want to remove the "daemon" mode options from the online docs. At this point we not want to remove the code, just not expose that it's there. It's unclear how to do this, please check it out and coordinate with changes from @nick-iris regarding his help changes.

timronan commented 5 years ago

Fixed by merged by #93.