From a2dc00800e8e1b7d974588079005add1dde9b8af Mon Sep 17 00:00:00 2001 From: Richard <42204099+rikroe@users.noreply.github.com> Date: Fri, 22 Nov 2024 09:11:24 +0100 Subject: [PATCH] More docs changes --- docs/source/captcha.rst | 12 ++++++++++-- docs/source/cli.rst | 23 +++++++++++++++++++++-- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/docs/source/captcha.rst b/docs/source/captcha.rst index 111e5d57..2aefb41d 100644 --- 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 index 85ac7cde..ea4c0aca 100644 --- 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