# UMA Auth CLI
A simple CLI tool for working with UMA auth. Can help with generating new nostr keys and publishing client app info events.
## Installation
To run the CLI from source, you can clone this repository and run:
```bash
pipenv install --dev
pipenv run python -m build
pip install dist/*.whl
```
You can then run the CLI from anywhere:
```bash
uma-auth-cli --help
```
To install the CLI as a package from pypi instead, you can run:
```bash
# Note: This is not yet published to pypi.
pip install uma-auth-cli
```
## Usage
### Key Generation
To generate a new nostr keypair, run:
```bash
uma-auth-cli generate-key
```
It will create and print a new keypair in hex and bech32 format:
```bash
nsec1e792rulwmsjanw783x39r8vcm23c2hwcandwahaw6wh39rfydshqxhfm7x
npub13msd7fakpaqerq036kk0c6pf9effz5nn5yk6nqj4gtwtzr5l6fxq64z8x5
sec hex: cf8aa1f3eedc25d9bbc789a2519d98daa3855dd8ecdaeedfaed3af128d246c2e
pub hex: 8ee0df27b60f419181f1d5acfc68292e52915273a12da9825542dcb10e9fd24c
```
### Publishing client app info
You can publish a client app info (kind 13195 and optionally kind 0) using the CLI. The CLI can publish these events in interactive prompt mode:
```bash
$ uma-auth-cli publish \
--nsec nsec1mqxnulkqkcv0gc0dfrxz5kz7d3h665ve2dhjkrj8jmmxwm4st2zsjv2n5l \
--relay wss://nos.lol --relay wss://relay.primal.net \
--redirect-uri https://foo.test \
--image https://foo.com/image.png \
--nip05 _@foo.com \
--include-0 \
--name "Test CLI" \
--description "A test client app"
```
### Looking up client app info
You can look up client app info using the CLI:
```bash
$ uma-auth-cli lookup \
--npub npub13msd7fakpaqerq036kk0c6pf9effz5nn5yk6nqj4gtwtzr5l6fxq64z8x5 \
--relay wss://nos.lol
```
Raw data
{
"_id": null,
"home_page": "https://docs.uma.me/",
"name": "uma-auth-cli",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Lightspark Group, Inc.",
"author_email": "info@lightspark.com",
"download_url": "https://files.pythonhosted.org/packages/8f/50/e0bfbc5e18d4687682b0dc99c0032e691c8f012ef50b02eff5f1245d976e/uma_auth_cli-0.1.1.tar.gz",
"platform": null,
"description": "# UMA Auth CLI\n\nA simple CLI tool for working with UMA auth. Can help with generating new nostr keys and publishing client app info events.\n\n## Installation\n\nTo run the CLI from source, you can clone this repository and run:\n\n```bash\npipenv install --dev\npipenv run python -m build\npip install dist/*.whl\n```\n\nYou can then run the CLI from anywhere:\n\n```bash\numa-auth-cli --help\n```\n\nTo install the CLI as a package from pypi instead, you can run:\n\n```bash\n# Note: This is not yet published to pypi.\npip install uma-auth-cli\n```\n\n## Usage\n\n### Key Generation\n\nTo generate a new nostr keypair, run:\n\n```bash\numa-auth-cli generate-key\n```\n\nIt will create and print a new keypair in hex and bech32 format:\n\n```bash\nnsec1e792rulwmsjanw783x39r8vcm23c2hwcandwahaw6wh39rfydshqxhfm7x\nnpub13msd7fakpaqerq036kk0c6pf9effz5nn5yk6nqj4gtwtzr5l6fxq64z8x5\n\nsec hex: cf8aa1f3eedc25d9bbc789a2519d98daa3855dd8ecdaeedfaed3af128d246c2e\npub hex: 8ee0df27b60f419181f1d5acfc68292e52915273a12da9825542dcb10e9fd24c\n```\n\n### Publishing client app info\n\nYou can publish a client app info (kind 13195 and optionally kind 0) using the CLI. The CLI can publish these events in interactive prompt mode:\n\n```bash\n$ uma-auth-cli publish \\\n--nsec nsec1mqxnulkqkcv0gc0dfrxz5kz7d3h665ve2dhjkrj8jmmxwm4st2zsjv2n5l \\\n--relay wss://nos.lol --relay wss://relay.primal.net \\\n--redirect-uri https://foo.test \\\n--image https://foo.com/image.png \\\n--nip05 _@foo.com \\\n--include-0 \\\n--name \"Test CLI\" \\\n--description \"A test client app\"\n```\n\n### Looking up client app info\n\nYou can look up client app info using the CLI:\n\n```bash\n$ uma-auth-cli lookup \\\n--npub npub13msd7fakpaqerq036kk0c6pf9effz5nn5yk6nqj4gtwtzr5l6fxq64z8x5 \\\n--relay wss://nos.lol\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "UMA Auth CLI tool for Client Apps.",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://github.com/uma-universal-money-address/uma-auth-cli/blob/main/README.md",
"Homepage": "https://docs.uma.me/",
"Source Code": "https://github.com/uma-universal-money-address/uma-auth-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a5de15104c0185509a34df16e39aeddee794d5f33259b390e9e476a0c17c1d9",
"md5": "fea5586bf4cadc37afb83af1ddc8c73a",
"sha256": "6b3a83456533f0ddb4405349265d2ba3dbeba252c1e43074cf227d92a8f197fa"
},
"downloads": -1,
"filename": "uma_auth_cli-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fea5586bf4cadc37afb83af1ddc8c73a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8479,
"upload_time": "2024-10-11T23:34:21",
"upload_time_iso_8601": "2024-10-11T23:34:21.996027Z",
"url": "https://files.pythonhosted.org/packages/5a/5d/e15104c0185509a34df16e39aeddee794d5f33259b390e9e476a0c17c1d9/uma_auth_cli-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f50e0bfbc5e18d4687682b0dc99c0032e691c8f012ef50b02eff5f1245d976e",
"md5": "8607e5c4255417403cfb8d571d3e3639",
"sha256": "85c283d5483a8d45c1cd3741157c18bfa7b14b0aa73c6ac3cf4eb65848552f70"
},
"downloads": -1,
"filename": "uma_auth_cli-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "8607e5c4255417403cfb8d571d3e3639",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7992,
"upload_time": "2024-10-11T23:34:23",
"upload_time_iso_8601": "2024-10-11T23:34:23.364456Z",
"url": "https://files.pythonhosted.org/packages/8f/50/e0bfbc5e18d4687682b0dc99c0032e691c8f012ef50b02eff5f1245d976e/uma_auth_cli-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 23:34:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uma-universal-money-address",
"github_project": "uma-auth-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "uma-auth-cli"
}
JSON
