Skip to content

Improve helper example section with env var usage #1580

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

Closed
wants to merge 1 commit into from
Closed

Improve helper example section with env var usage #1580

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
19 changes: 19 additions & 0 deletions docs/cli-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,25 @@ In `/path/to/helper.sh`:

#!/bin/bash
pass show path/to/password | head -n 1

Example for an `environnement variable`:

.. code-block:: ini

[global]
default = somewhere
ssl_verify = true
timeout = 5

[somewhere]
url = http://somewhe.re
private_token = helper: printf -- '%%s' ${GITLAB_TOKEN}
timeout = 1

**Notice:**

* ``printf`` is the executable provided by coreutils package (on a debian based distribution).
* ``%`` must be escaped using an other `%` (in order to allow `configparser` load configuration properly.
Comment on lines +185 to +191
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this contribution @glennie! Initially I wanted to say this would probably be superseded by #1296, but I like your idea because you can define multiple env vars (e.g. one per gitlab id entry).

Just one question: Wouldn't simply using echo -n ${VARIABLE} achieve the same? Have you tried this? -n should strip the newline.


CLI
===
Expand Down