Skip to content

fix(docs/config): use correct format for env config #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
safl merged 1 commit into from
Aug 4, 2026
Merged

fix(docs/config): use correct format for env config #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/source/configs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,16 @@ Shell Configuration
``cijoe.run.env``
~~~~~~~~~~~~~~~~~

It is possible to set up environment variables for the **target** system. All
calls to ``cijoe.run(...)`` will be given the environment variables defined by
this configuration option.
Optionally, it is possible to set up environment variables for the **target**
system. All calls to ``cijoe.run(...)`` will be given the environment variables
defined by this configuration option.

Example:

.. code-block:: ini
.. code-block:: toml

cijoe.run.env = PATH=/usr/local/bin:/usr/bin, LANG=en_US.UTF-8
[cijoe.run]
env = { PATH = "/usr/local/bin:/usr/bin", LANG = "en_US.UTF-8" }

In this example, any command run through ``cijoe.run(...)`` will use the
specified ``PATH`` and ``LANG`` variables.
Expand Down