cli: Add examples to default help

tony · tony · commit df220972c250 · 2022-10-16T17:19:51.000-05:00
diff --git a/src/vcspull/cli/__init__.py b/src/vcspull/cli/__init__.py
@@ -6,6 +6,7 @@
 """
 import argparse
 import logging
+import textwrap
 
 from libvcs.__about__ import __version__ as libvcs_version
 
@@ -17,7 +18,22 @@
 
 
 def create_parser():
-    parser = argparse.ArgumentParser(prog="vcspull")
+    parser = argparse.ArgumentParser(
+        prog="vcspull",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description=textwrap.dedent(
+            """
+            sync vcspull repos
+
+            examples:
+              vcspull sync "*"
+              vcspull sync "django-*"
+              vcspull sync "django-*" flask
+              vcspull sync -c "myrepos.yaml" "*"
+              vcspull sync -c "myrepos.yaml" myproject
+        """
+        ).strip(),
+    )
     parser.add_argument(
         "--version",
         "-V",
