More docs changes

bimmerconnected · Nov 22, 2024 · a2dc008 · a2dc008
1 parent 4f8a283
commit a2dc008
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 4 deletions.
diff --git a/docs/source/captcha.rst b/docs/source/captcha.rst
@@ -18,7 +18,7 @@ When using the Python API, pass the token via the :code:`hcaptcha_token` argumen
 
 .. warning::
 
-   Ensure to save the current `MyBMWAccount` instance (or at least, the `refresh_token` and `gcid` attributes) to avoid having to solve the captcha again.
+   Ensure to save the current :code:`MyBMWAccount` instance (or at least, the :code:`refresh_token` and :code:`gcid` attributes) to avoid having to solve the captcha again.
 
 ::
 
@@ -31,8 +31,16 @@ When using the CLI, pass the token via the :code:`--hcaptcha-token` argument (se
 
 .. warning::
 
-   Please make sure to use the `--oauth-store` (used by default) to avoid having to solve the captcha again.
+   Please make sure to use the :code:`--oauth-store` (used by default) to avoid having to solve the captcha again.
 
 ::
 
   bimmerconnected status --captcha-token CAPTCHA_TOKEN USERNAME PASSWORD REGION
+
+After a successful login, the :code:`--captcha-token` parameter can be omitted (until a captcha is required again, indicated by a :code:`invalid login` error).
+
+::
+
+  bimmerconnected status USERNAME PASSWORD REGION
+
+
diff --git a/docs/source/cli.rst b/docs/source/cli.rst
@@ -1,7 +1,26 @@
-.. _cli_module:
+:mod:`bimmerconnected` CLI
+==========================
+
+The :code:`bimmerconnected` CLI is a command line interface to interact with the BMW ConnectedDrive API. 
+A full documentation of the commands can be found below.
+
+.. warning::
+
+   The CLI will store your tokens in a file called :mod:`.bimmer_connected.json` in your home directory (:code:`--oauth-store` parameter).
+   You can move this file, but is is required to function properly (have multiple calls). 
+   The data is stored in plain text, so protect this file accordingly.
+
+.. note::
+
+   The first login (or after a long time) requires a captcha to be solved (see :doc:`captcha`).
+   Follow-up logins using refresh token do not require a captcha (as data is persisted as per above).
+
+   These follow-up logins also **do not** require the :code:`--captcha-token` parameter.
 
 :mod:`bimmerconnected`
-======================
+-----------------------
+
+.. _cli_module:
 
 .. argparse::
    :module: bimmer_connected.cli