Skip to content

Commit

Permalink
feat: small cli doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hartym committed Feb 23, 2024
1 parent 81cc65b commit 732d2fd
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions harp/commandline/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@
Manage process list / options using a class (with hierarchy for prod/dev, for example)
If one process only, no honcho ? Or mayne no honcho manager ?
The `entrypoint` callable is the entrypoint for the `harp` command line interface, installed into your environment when
running either `poetry install`or `pip install`.
It must be considered as a high-level development helper: for example, `harp start` wraps `honcho`, a python
process manager (foreman clone) that can spawn multiple processes to help you with development.
Production environment will favour the lower-level `bin/entrypoint` script, that skips the process manager entirely
and runs the application server directly.
This may be subject to changes in the future (espacially to align/refactor arg parsers), but this approach works
well for now.
"""

import rich_click as click
Expand All @@ -25,6 +38,11 @@

@click.group()
def entrypoint():
"""HTTP Application Runtime Proxy (HARP)
The following commands are available to help you setup and run your HTTP proxy application.
"""
pass


Expand Down

0 comments on commit 732d2fd

Please sign in to comment.