Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drmikecrowe/xontrib-1password
Easy 1password support for xonsh
https://github.com/drmikecrowe/xontrib-1password
1password xonsh xontrib
Last synced: 2 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 (21 days ago)
- Default Branch: main
- Last Pushed: 2025-01-29T12:08:05.000Z (11 days ago)
- Last Synced: 2025-01-29T12:32:59.089Z (11 days ago)
- Topics: 1password, xonsh, xontrib
- Language: Python
- Homepage:
- Size: 80.1 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
If you like the idea click ⭐ on the repo and tweet.
> **ALPHA**: This is the initial release. Issues/pull requests are welcome.
## Introduction
This xontrib adds support for 1Password secrets to the xonsh shell by utilizing the [op (1password CLI)](https://developer.1password.com/docs/cli/). It works by allowing you to securely store and access your passwords in 1Password. To use:
1. Store your passwords in 1Password.
2. In your xonsh environment, reference the passwords using the OnePass function:
```xsh
$OPENAI_API_KEY = OnePass("op://Private/OpenAI-API-Key/api-key")
```
3. To expose the variables in your environment, set:
```xsh
$ONEPASS_ENABLED = 1
```
This approach ensures your sensitive information remains secure while being easily accessible in your xonsh shell. The URL is basically: `op:////`. To find this, here's the commands I used 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"
```
## Installation
To install use pip:
```xsh
xpip install xontrib-1password
# or: xpip install -U git+https://github.com/drmikecrowe/xontrib-1password
```
## Usage
This xontrib will get loaded automatically for interactive sessions.
To disable autoloading:
```xsh
$XONTRIBS_AUTOLOAD_DISABLED = ["1password", ]
# if you have set this for other xontribs, you should append the value
```
## Examples
## Known issues
None
## 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).