openai/sign-in-with-chatgpt-devkit
Sign-in with ChatGPT DevKit — local SDK, reusable React components, design assets, and the Paste Perfect desktop example. - openai/sign-in-with-chatgpt-devkit
2 stars · 1 forks
README
Sign in with ChatGPT DevKit Sign in with ChatGPT lets users sign in to your app with their ChatGPT account. With their permission, eligible users can also use their ChatGPT plan to power your app's AI features without setting up an API key.
This DevKit is for developers building open-source apps that run on a user's own machine. It gives you a local Node.js SDK, React components, and design assets to integrate Sign in with ChatGPT, plus Paste Perfect, a working macOS example app you can learn from.
Use the DevKit in your app Follow the Paste Perfect cookbook for a step-by-step integration. See the developer documentation for authentication and ChatGPT plan usage. Use @siwc/local in your app's local Node.js process for sign-in and API requests, and @siwc/react for the UI. Import @siwc/react/styles.css once. Both packages are local workspaces in this repository; Paste Perfect shows how to connect them, including OS-encrypted credential storage. What's included
Folder Contents
packages/local OAuth, credential storage, account profiles, model discovery, and streaming Responses.
packages/react React components for sign-in, connection status, and ChatGPT plan usage.
assets ChatGPT marks, icons, sign-in buttons, and fonts.
examples/component-gallery Design examples for sign-in, account connections, and ChatGPT plan usage controls.
examples/paste-perfect An example native macOS app that uses Sign in with ChatGPT to transform copied text and paste the result into another app, with an Electron settings dashboard.
Running the example Paste Perfect app with Sign in with ChatGPT Requires macOS 14 or later, Node.js 22.12 or later, and Xcode Command Line Tools. git clone https://github.com/openai/sign-in-with-chatgpt-devkit.git cd sign-in-with-chatgpt-devkit npm ci npm run build npm start
Sign in with ChatGPT from the dashboard. Enable native paste and grant Accessibility access to the native helper. Copy text, focus an editable field in another app, press ⌘⇧Space, then right-click within eight seconds. Choose Spreadsheet, Message, Translate, Checklist, Clean up, or a saved recipe.
The result is pasted into the destination app. Use the Electron dashboard to manage accounts, settings, recipes, and activity. Paste Perfect currently supports text on macOS; compatibility varies by destination app. Branding and Design Guidelines Use the UI/UX guidelines and design assets to add a familiar sign-in experience, show which ChatGPT account is connected, and make plan usage controls easy to find. Try the components with your app's name and layout to choose button styles, check connection states, and place usage indicators where users need them.
To try the designs locally after installing dependencies: npm run dev:gallery Open the local URL printed in your terminal. Licence OpenAI-authored code and documentation are licensed under the Sign-in with ChatGPT DevKit Noncommercial License v1.0. Third-party fonts and dependencies retain their own licences; see third-party notices and the dependency inventory. OpenAI trademarks remain subject to the OpenAI brand guidelines. Bundled Inter and Open Sans fonts include their licence files. SF Pro uses the system font on Apple platforms and falls back on other platforms. For contribution policy, see CONTRIBUTING.md.