https://github.com/drmikecrowe/xontrib-1password
Easy 1password support for xonsh
https://github.com/drmikecrowe/xontrib-1password
1password xonsh xontrib
Last synced: 6 days ago
JSON representation
Easy 1password support for xonsh
- Host: GitHub
- URL: https://github.com/drmikecrowe/xontrib-1password
- Owner: drmikecrowe
- License: mit
- Created: 2025-01-19T16:19:06.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T12:47:23.000Z (2 months ago)
- Last Synced: 2025-04-15T00:12:22.651Z (6 days ago)
- Topics: 1password, xonsh, xontrib
- Language: Python
- Homepage:
- Size: 126 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
1password support for xonsh shell. This approach ensures your sensitive information remains secure while being easily accessible in your xonsh shell.
If you like the idea click ⭐ on the repo and tweet.
## Installation
To install use pip:
```xsh
xpip install xontrib-1password
# or: xpip install -U git+https://github.com/drmikecrowe/xontrib-1password
```
The xontrib will get loaded automatically.
## Usage
Store your passwords in [1Password](https://1password.com/) and setup [`op` CLI](https://developer.1password.com/docs/cli/) locally.
Then:
```xsh
mykey = OnePass("op://path/my/key")
echo @(mykey)
# my-key-value
$MYKEY = OnePass("op://path/my/key")
echo $MYKEY
# my-key-value
env | grep MYKEY
# MYKEY=my-key-value
```
## Good to know
### Disabling
To disable autoloading:
```xsh
$XONTRIBS_AUTOLOAD_DISABLED = ["1password", ]
```
To turn off:
```xsh
$XONTRIB_1PASSWORD_ENABLED = False
$MYKEY = OnePass("op://path/my/key")
$MYKEY
# op://path/my/key
```
### Get certain key
Because of the URL is basically `op:////` to find this, here's the commands you can use to determine these fields:
```sh
op item list --format json | jq '.[].title | select(. | contains("OpenAI"))'
# "OpenAI-API-Key"
op item get OpenAI-API-Key --format json | jq '.fields[] | select(.type == "CONCEALED") | .label'
# "api-key"
```
### Debug mode
```xsh
$XONTRIB_1PASSWORD_DEBUG = True
```
### Cache
You can set `$XONTRIB_1PASSWORD_CACHE` to string:
* `not_empty` (default) - cache not empty values.
* `all` - cache all values.
* `off` - disable caching.
## Known issues
### Slowing down reading environment variables
If you disable cache (i.e. `$XONTRIB_1PASSWORD_CACHE='off'`) in case of `$MYVAR = OnePass(...)` every time the shell read the env variables list the value will be requested from OnePassword and it takes time.
## Development
- activate [pre-commit](https://github.com/pre-commit/pre-commit) hooks
```sh
# install pre-commit plugins and activate the commit hook
pre-commit install
pre-commit autoupdate
```
### Releasing your package
- Bump the version of your package.
- Create a GitHub release (The release notes are automatically generated as a draft release after each push).
- And publish with `poetry publish --build` or `twine`
## Credits
This package was created with [xontrib template](https://github.com/xonsh/xontrib-template).