From 402aac2366b17ea3186730f20457812c77b4266d Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Wed, 31 Jan 2024 11:48:43 -0800 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b7bd0ff2..66743966 100644 --- a/README.md +++ b/README.md @@ -190,7 +190,7 @@ curl -sSL 'https://docker-compose.archivebox.io' > docker-compose.yml
  • Next steps: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin. 
    docker compose up
 # completely optional, CLI can always be used without running a server
-# docker compose run [-T] archivebox [subcommand] [--args]
+# docker compose run [-T] archivebox [subcommand] [--help]
 docker compose run archivebox add 'https://example.com'
 docker compose run archivebox help
    • @@ -213,7 +213,7 @@ docker run -v $PWD:/data -it archivebox/archivebox init --setup
  • Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin. 
    docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
 # completely optional, CLI can always be used without running a server
-# docker run -v $PWD:/data -it [subcommand] [--args]
+# docker run -v $PWD:/data -it [subcommand] [--help]
 docker run -v $PWD:/data -it archivebox/archivebox help
    • @@ -265,7 +265,7 @@ archivebox init --setup
  • Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin. 
    archivebox server 0.0.0.0:8000
 # completely optional, CLI can always be used without running a server
-# archivebox [subcommand] [--args]
+# archivebox [subcommand] [--help]
 archivebox help
    • @@ -301,7 +301,7 @@ archivebox init --setup # if any problems, install with pip instead
  • Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin. 
    archivebox server 0.0.0.0:8000
 # completely optional, CLI can always be used without running a server
-# archivebox [subcommand] [--args]
+# archivebox [subcommand] [--help]
 archivebox help
    • @@ -330,7 +330,7 @@ archivebox init --setup # if any problems, install with pip instead
  • Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin. 
    archivebox server 0.0.0.0:8000
 # completely optional, CLI can always be used without running a server
-# archivebox [subcommand] [--args]
+# archivebox [subcommand] [--help]
 archivebox help
    • @@ -458,13 +458,13 @@ ArchiveBox commands can be run in a terminal directly on your host, or via Docke mkdir -p ~/archivebox/data # create a new data dir anywhere cd ~/archivebox/data # IMPORTANT: cd into the directory -# archivebox [subcommand] [--args] +# archivebox [subcommand] [--help] archivebox help -# equivalent: docker compose run archivebox [subcommand [--args] +# equivalent: docker compose run archivebox [subcommand [--help] docker compose run archivebox help -# equivalent: docker run -it -v $PWD:/data archivebox/archivebox [subcommand [--args] +# equivalent: docker run -it -v $PWD:/data archivebox/archivebox [subcommand [--help] docker run -it -v $PWD:/data archivebox/archivebox help ``` @@ -482,7 +482,7 @@ docker compose run archivebox help 
    
 # make sure you have pip-installed ArchiveBox and it's available in your $PATH first  
 
    
-# archivebox [subcommand] [--args]
+# archivebox [subcommand] [--help]
 archivebox init --setup      # safe to run init multiple times (also how you update versions)
 archivebox version           # get archivebox version info + check dependencies
 archivebox help              # get list of archivebox subcommands that can be run
@@ -498,7 +498,7 @@ archivebox add --depth=1 'https://news.ycombinator.com'
 
    
 # make sure you have `docker-compose.yml` from the Quickstart instructions first
 
    
-# docker compose run archivebox [subcommand [--args]
+# docker compose run archivebox [subcommand [--help]
 docker compose run archivebox init --setup
 docker compose run archivebox version
 docker compose run archivebox help
@@ -515,7 +515,7 @@ docker compose run archivebox add --depth=1 'https://news.ycombinator.com'
 
    
 # make sure you create and cd into in a new empty directory first  
 
    
-# docker run -it -v $PWD:/data archivebox/archivebox [subcommand [--args]
+# docker run -it -v $PWD:/data archivebox/archivebox [subcommand [--help]
 docker run -v $PWD:/data -it archivebox/archivebox init --setup
 docker run -v $PWD:/data -it archivebox/archivebox version
 docker run -v $PWD:/data -it archivebox/archivebox help