Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcvs committed Apr 23, 2024
1 parent dd31a69 commit f7da317
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
23 changes: 23 additions & 0 deletions gitbook/oidc-tokensh/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## General Usage

`oidc-tokensh` is a tool to ensure that valid Access Tokens are always
available in a location such as `$XDG_RUNTIME_DIR/bt_u$ID`,
`/tmp/bt_u$ID`, or `$BEARER_TOKEN_FILE` just as specified
<https://zenodo.org/records/3937438>.

`oidc-tokensh` provides an "almost drop-in replacement" for `httokensh` of
the [htgettoken](https://github.com/fermitools/htgettoken) tool package.

`oidc-tokensh` starts a new shell through `oidc-agent` and prompts the user
for the passphrase of the `oidc-agent shortname` that will be loaded.

The user may specify the `shortname` with the `--oidc <shortname>` option.
If only one `shortname` is configured, this one will be used by default.

```
Usage: oidc-tokensh [--oidc <shortname>] [-- <command>]
```


See [Detailed Information About All
Options](options.md) for more information.
34 changes: 34 additions & 0 deletions gitbook/oidc-tokensh/options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Detailed Information About All Options

* [`-h, --help`](#help)
* [`--oidc <name>|<OP-url>`](#oidc)
* [`--minsecs <seconds>`](#minsecs)
* [`-o|--outfile <file>`](#outfile)
* [`-v|--verbose`](#verbose)
* [`-- <command>`](#command)


### `--oidc`

This option is used to specify the `shortname` of an `oidc-agent`
configuration. If only one agent configuration is defined, this option may
be skipped.

### `--minsecs`

Specify the minimum number of seconds that the Access Token should still
be valid for.

### `--outfile`

Specify alternative file for storing the Access Token.

### `--verbose`

Show debug output

### `-- <command>`

Instead of the default shell, you can specify any other shell-like command
here. This is useful to specify your favourite shell.

0 comments on commit f7da317

Please sign in to comment.