From 2135499d1aed84e8127f8607ffecdac698faef4b Mon Sep 17 00:00:00 2001 From: Priyansh Khodiyar Date: Thu, 14 May 2026 19:46:27 +0530 Subject: [PATCH 1/2] docs(readme): overhaul with logo, community, security, and integrations The README had grown stale relative to the project's current state. This brings it up to par with comparable open-source credential tools (Doppler, Infisical) and agent infra READMEs (Ollama, Continue). Tier 1 (correctness): - Fix Tests + codecov badge URLs from manojbajaj95 to agentrhq. - Drop broken link to docs/specs/authsome-v1.md (removed upstream). - Replace 3 em-dashes with periods per house style. - Repoint Docs section links to hosted authsome.agentr.dev/docs instead of local MDX paths (better reading experience on GitHub). Tier 2 (close gaps every comparable project has): - Add Install section before Quick Start with pip and uvx commands. - Add Community section linking Discord and Issues. - Add Security section pointing at the responsible disclosure policy. Critical for a credential tool; was previously absent. - Add Contributing section linking to CONTRIBUTING.md. Tier 3 (polish and differentiation): - Add light/dark wordmark logo at top (reuses the SVG mark shipped to the docs site, sized for README hero). - Add header link bar (Docs / Website / Discord / Issues). - Surface "44 bundled providers" callout near the top. - Add Agent Integrations section listing Claude Code, Codex, Cursor, OpenCode, LangChain, LlamaIndex, OpenAI Agents SDK, Anthropic SDK. - Add Discord badge to the badge row. - Replace the ASCII art block with the logo image. The ASCII was a placeholder before a real brand mark existed. --- README.md | 117 +++++++++++++++++++++++---------- assets/authsome-logo-dark.svg | 6 ++ assets/authsome-logo-light.svg | 6 ++ 3 files changed, 96 insertions(+), 33 deletions(-) create mode 100644 assets/authsome-logo-dark.svg create mode 100644 assets/authsome-logo-light.svg diff --git a/README.md b/README.md index f079c54..bd4bb06 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,37 @@ -# authsome - -[![PyPI version](https://img.shields.io/pypi/v/authsome.svg)](https://pypi.org/project/authsome/) -[![Python 3.13+](https://img.shields.io/pypi/pyversions/authsome.svg)](https://pypi.org/project/authsome/) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![PyPI downloads](https://img.shields.io/pypi/dm/authsome.svg)](https://pypi.org/project/authsome/) -[![Tests](https://github.com/manojbajaj95/authsome/actions/workflows/test.yml/badge.svg)](https://github.com/manojbajaj95/authsome/actions/workflows/test.yml) -[![codecov](https://codecov.io/gh/manojbajaj95/authsome/branch/main/graph/badge.svg)](https://codecov.io/gh/manojbajaj95/authsome) - -```text - __ __ - ____ ___ __/ /_/ /_ _________ ____ ___ ___ - / __ `/ / / / __/ __ \/ ___/ __ \/ __ `__ \/ _ \ -/ /_/ / /_/ / /_/ / / (__ ) /_/ / / / / / / __/ -\__,_/\__,_/\__/_/ /_/____/\____/_/ /_/ /_/\___/ -``` +

+ + + + Authsome + +

+ +

+ PyPI version + Python 3.13+ + License: MIT + PyPI downloads + Tests + Discord +

+ +

+ Local-first credential broker and vault for AI Agents +

+ +

+ Docs · + Website · + Discord · + Issues +

-**Local-first credential broker and vault for AI Agents** +--- An open-source credential broker that sits between your agents and the services they call. Instead of sharing credentials with every agent, log in once via OAuth2 or API keys. Authsome stores credentials securely and injects them via an HTTP proxy. You get one place to manage access, rotate keys, and see what every agent is doing. +**44 bundled providers** out of the box: 13 OAuth2 and 31 API key. [See the full list](https://authsome.agentr.dev/docs/reference/bundled-providers). + --- ## Demo @@ -27,7 +40,7 @@ https://github.com/user-attachments/assets/27f9b229-baf4-4889-be9a-378a133654dc --- -## Why Agents need Authsome +## Why Agents Need Authsome Agents run beyond interactive sessions. They live in CI, over SSH, in cron jobs, in background workers, and in parallel pipelines. They need API access that survives without a human in the loop. @@ -35,7 +48,7 @@ Hardcoded environment tokens leak or go stale, and building auth flow logic, tok Authsome is the local credential layer agents call at runtime. -- **No credential sprawl.** One encrypted store — every provider, every agent, one place. +- **No credential sprawl.** One encrypted store. Every provider, every agent, one place. - **No SaaS, no privacy trade-off.** Credentials never leave your machine. Eliminates credential exfiltration risks as agents never see them. - **No browser required at runtime.** Setup can use browser PKCE, device code, or a browser bridge for secure API key entry. After that, agents run headlessly. @@ -83,7 +96,7 @@ Credentials are stored locally, encrypted at rest, and refreshed before expiry. | Automatic token refresh | ✅ | ❌ | build it | | OAuth2 + API keys | ✅ | ❌ | build it | | Runtime headless use | ✅ | ✅ | varies | -| Local — no SaaS dependency | ✅ | ✅ | ✅ | +| Local, no SaaS dependency | ✅ | ✅ | ✅ | | Built-in providers, zero config | ✅ | ❌ | ❌ | | Multi-account per provider | ✅ | ❌ | build it | @@ -91,26 +104,55 @@ Authsome gives agents one command for a valid token, without scattering long-liv --- +## Install + +Requires Python 3.13+. + +```bash +pip install authsome +``` + +Or run without installing: + +```bash +uvx authsome@latest --help +``` + ## Quick Start ```bash -uvx authsome login github # opens browser, completes PKCE flow +uvx authsome login github # opens browser, completes PKCE flow uvx authsome login github --flow device_code # headless: Device Code, works over SSH and CI -uvx authsome login openai # secure API key entry via browser bridge -uvx authsome list # all connections + token status +uvx authsome login openai # secure API key entry via browser bridge +uvx authsome list # all connections + token status ``` +## Agent Integrations + +Authsome ships with adapters for the most common agent frameworks and CLIs: + +- [Claude Code](https://authsome.agentr.dev/docs/integrations/agents/claude-code) +- [Codex](https://authsome.agentr.dev/docs/integrations/agents/codex) +- [Cursor](https://authsome.agentr.dev/docs/integrations/agents/cursor) +- [OpenCode](https://authsome.agentr.dev/docs/integrations/agents/opencode) +- [LangChain](https://authsome.agentr.dev/docs/integrations/agents/langchain) +- [LlamaIndex](https://authsome.agentr.dev/docs/integrations/agents/llamaindex) +- [OpenAI Agents SDK](https://authsome.agentr.dev/docs/integrations/agents/openai-agents-sdk) +- [Anthropic SDK](https://authsome.agentr.dev/docs/integrations/agents/anthropic-sdk) + +Full list at [authsome.agentr.dev/docs/integrations](https://authsome.agentr.dev/docs/integrations/agents/index). + ## Docs -The full documentation site lives in [`docs/site/`](docs/site/) +Full documentation lives at **[authsome.agentr.dev/docs](https://authsome.agentr.dev/docs)**. -- [Quickstart](docs/site/quickstart.mdx) -- [CLI reference](docs/site/reference/cli.mdx) -- [Architecture](docs/site/concepts/architecture.mdx) -- [Custom providers](docs/site/guides/custom-providers.mdx) -- [Troubleshooting](docs/site/troubleshooting/doctor.mdx) +- [Quickstart](https://authsome.agentr.dev/docs/quickstart) +- [CLI reference](https://authsome.agentr.dev/docs/reference/cli) +- [Architecture](https://authsome.agentr.dev/docs/concepts/architecture) +- [Custom providers](https://authsome.agentr.dev/docs/guides/custom-providers) +- [Troubleshooting](https://authsome.agentr.dev/docs/troubleshooting/doctor) -To preview locally: +To preview the docs site locally: ```bash cd docs/site @@ -118,12 +160,21 @@ npm i -g mint # requires Node.js >= 20.17.0 mint dev ``` +## Community + +- **[Discord](https://discord.gg/9YP2C9tvMp)** for questions, help, and showing what you're building. +- **[GitHub Issues](https://github.com/agentrhq/authsome/issues)** for bugs and feature requests. + +## Security + +Authsome is a credential tool. If you find a vulnerability, please do **not** open a public GitHub issue. +See the [responsible disclosure policy](https://authsome.agentr.dev/docs/security/disclosure) for how to report it privately. -## Specs +## Contributing -- [Authsome v1](docs/specs/authsome-v1.md) +Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, testing, and the engineering principles we follow. ## License -MIT — see [LICENSE](LICENSE). +MIT. See [LICENSE](LICENSE). diff --git a/assets/authsome-logo-dark.svg b/assets/authsome-logo-dark.svg new file mode 100644 index 0000000..ce1a0b7 --- /dev/null +++ b/assets/authsome-logo-dark.svg @@ -0,0 +1,6 @@ + + + + +authsome + diff --git a/assets/authsome-logo-light.svg b/assets/authsome-logo-light.svg new file mode 100644 index 0000000..b485ffb --- /dev/null +++ b/assets/authsome-logo-light.svg @@ -0,0 +1,6 @@ + + + + +authsome + From 373a4a80e9de7e1e4dd587e270fe960774d0d6aa Mon Sep 17 00:00:00 2001 From: Priyansh Khodiyar Date: Thu, 14 May 2026 19:49:18 +0530 Subject: [PATCH 2/2] docs(readme): add codecov badge and star history chart Adds the codecov badge to the badge row alongside the existing Tests badge so the coverage signal sits next to the build signal. Adds a Star History chart between Contributing and License using the star-history.com embed, with light/dark variants via . The codecov badge depends on the codecov integration being wired up for agentrhq/authsome; if it isn't yet, the badge will render as "unknown" until the integration is enabled. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index bd4bb06..0f45f48 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ License: MIT PyPI downloads Tests + codecov Discord

@@ -175,6 +176,16 @@ See the [responsible disclosure policy](https://authsome.agentr.dev/docs/securit Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, testing, and the engineering principles we follow. +## Star History + + + + + + Star History Chart + + + ## License MIT. See [LICENSE](LICENSE).