refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wyattjoh merged 2 commits into from
Mar 13, 2026
Merged

refactor: migrate to @napi-rs/keyring and env-paths #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74d065a
refactor: migrate to @napi-rs/keyring and env-paths
wyattjoh Mar 12, 2026
aa344d6
Apply suggestion from @rafa-thayto
wyattjoh Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.example
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000
32 changes: 32 additions & 0 deletions bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
},
"type": "module",
"scripts": {
"build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
"build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
"dev": "bun run ./src/cli.ts",
"test": "bun test",
"lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
},
"dependencies": {
"@inquirer/prompts": "^8.2.0",
"@napi-rs/keyring": "^1.2.0",
"commander": "^14.0.3",
"env-paths": "^4.0.0",
"yaml": "^2.8.2"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion src/lib/config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
* Config file management for ~/.clerk/config.json.
* Config file management for the Clerk CLI config file.
* Stores auth identity and path-keyed project profiles.
*/

Expand Down
17 changes: 7 additions & 10 deletions src/lib/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
* Centralizes configuration values that are used across multiple modules.
*/

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";
56 changes: 34 additions & 22 deletions src/lib/credential-store.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
keyringModule = await import("@napi-rs/keyring");
} catch {
keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
KEYCHAIN_SERVICE,
KEYCHAIN_ACCOUNT,
async storeToken(token: string) {
if (isMacOS) {
if (keyringModule) {
try {
await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
entry.setPassword(token);
return;
} catch {}
}
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
await chmod(f, 0o600);
},
async getToken() {
if (isMacOS) {
if (keyringModule) {
try {
return (
await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
)
.text()
.trim();
const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
return entry.getPassword();
} catch {}
}
const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
return content.trim() || null;
},
async deleteToken() {
if (isMacOS) {
if (keyringModule) {
try {
await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
entry.deletePassword();
} catch {}
}
const file = Bun.file(credFile());
if (await file.exists()) await Bun.write(credFile(), "");
try {
await unlink(credFile());
} catch {
// File doesn't exist, nothing to delete
}
},
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
// Restore any pre-existing keychain token on macOS
if (process.platform === "darwin" && savedToken !== null) {
// Restore any pre-existing keyring token
if (keyringModule && savedToken !== null) {
await storeToken(savedToken);
}
delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
beforeEach(async () => {
// On first run, save any existing keychain token so we can restore it later
if (process.platform === "darwin" && savedToken === null) {
// On first run, save any existing keyring token so we can restore it later
if (keyringModule && savedToken === null) {
savedToken = await getToken();
}
await deleteToken();
Expand Down
70 changes: 46 additions & 24 deletions src/lib/credential-store.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
* Credential store for persisting the OAuth access token.
* Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
* Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
*/

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
if (keyringModule !== undefined) return keyringModule;
try {
// -U flag updates existing entry if present
await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
keyringModule = await import("@napi-rs/keyring");
return keyringModule;
} catch {
keyringModule = null;
return null;
}
}

async function keyringStore(token: string): Promise<boolean> {
const mod = await getKeyring();
if (!mod) return false;
try {
const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
entry.setPassword(token);
return true;
} catch {
return false;
}
}

async function keychainGet(): Promise<string | null> {
if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
const mod = await getKeyring();
if (!mod) return null;
try {
const result =
await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
return result.text().trim();
const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
return entry.getPassword();
} catch {
return null;
}
}

async function keychainDelete(): Promise<boolean> {
if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
const mod = await getKeyring();
if (!mod) return false;
try {
await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
entry.deletePassword();
return true;
} catch {
return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
const file = Bun.file(CREDENTIALS_FILE);
if (await file.exists()) {
await Bun.write(CREDENTIALS_FILE, "");
try {
await unlink(CREDENTIALS_FILE);
} catch {
// File doesn't exist, nothing to delete
}
}

export async function storeToken(token: string): Promise<void> {
const stored = await keychainStore(token);
if (!stored) {
await fileStore(token);
const stored = await keyringStore(token);
if (stored) {
// Clean up any stale plaintext credentials from a previous file-based storage
await fileDelete();
return;
}

await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
if (tokenOverride !== undefined) return tokenOverride;
const token = await keychainGet();
const token = await keyringGet();
if (token) return token;
return fileGet();
}

export async function deleteToken(): Promise<void> {
await keychainDelete();
await keyringDelete();
await fileDelete();
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
refactor: migrate to @napi-rs/keyring and env-paths#28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 2 commits into

from

Mar 13, 2026
 Merged


refactor: migrate to @napi-rs/keyring and env-paths
#28
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
74d065a

refactor: migrate to @napi-rs/keyring and env-paths


wyattjoh Mar 12, 2026
aa344d6

Apply suggestion from @rafa-thayto


wyattjoh Mar 13, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.env.example

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
# CLERK_PLATFORM_API_URL=https://api.clerk.com

# ── Config / credentials storage ─────────────────────────────────────────────
# CLERK_CONFIG_DIR=~/.clerk
# CLERK_CONFIG_DIR=/path/to/custom/dir

# ── Auth callback ────────────────────────────────────────────────────────────
# CLERK_AUTH_TIMEOUT_MS=120000

32 changes: 32 additions & 0 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 },
 "type": "module",
 "scripts": {
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node",
 "build": "bun build ./src/cli.ts --outfile ./dist/cli.js --target node --external @napi-rs/keyring",
 "dev": "bun run ./src/cli.ts",
 "test": "bun test",
 "lint": "oxlint src/",
Expand All@@ -17,7 +17,9 @@
 },
 "dependencies": {
 "@inquirer/prompts": "^8.2.0",
 "@napi-rs/keyring": "^1.2.0",
 "commander": "^14.0.3",
 "env-paths": "^4.0.0",
 "yaml": "^2.8.2"
 },
 "devDependencies": {
Expand Down

2 changes: 1 addition & 1 deletion
src/lib/config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/**
 * Config file management for ~/.clerk/config.json.
 * Config file management for the Clerk CLI config file.
 * Stores auth identity and path-keyed project profiles.
 */

Expand Down

17 changes: 7 additions & 10 deletions
src/lib/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,16 @@
 * Centralizes configuration values that are used across multiple modules.
 */

import { homedir } from "node:os";
import { join } from "node:path";
import envPaths from "env-paths";

// ── File paths ──────────────────────────────────────────────────────────────

export const CLERK_HOME_DIR = process.env.CLERK_CONFIG_DIR ?? join(homedir(), ".clerk");
export const CONFIG_FILE = join(CLERK_HOME_DIR, "config.json");
export const CREDENTIALS_FILE = join(CLERK_HOME_DIR, "credentials");
const clerkConfigDir = process.env.CLERK_CONFIG_DIR;
const paths = envPaths("clerk-cli", { suffix: false });

export const CONFIG_FILE = join(clerkConfigDir ?? paths.config, "config.json");
export const CREDENTIALS_FILE = join(clerkConfigDir ?? paths.data, "credentials");

// ── OAuth ───────────────────────────────────────────────────────────────────

Expand DownExpand Up@@ -46,10 +48,5 @@ export const OPENAPI_SPEC_URLS = {

// ── Cache ────────────────────────────────────────────────────────────────

export const CLERK_CACHE_DIR = join(CLERK_HOME_DIR, "cache");
export const CLERK_CACHE_DIR = clerkConfigDir ? join(clerkConfigDir, "cache") : paths.cache;
export const CACHE_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours

// ── Keychain ────────────────────────────────────────────────────────────────

export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

56 changes: 34 additions & 22 deletions
src/lib/credential-store.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
import { test, expect, describe, beforeEach, afterAll, mock } from "bun:test";
import { mkdtemp, rm, mkdir, chmod } from "node:fs/promises";
import { test, expect, describe, beforeEach, afterAll, mock, setDefaultTimeout } from "bun:test";

// Keyring initialization can be slow on first access (macOS Keychain, etc.)
setDefaultTimeout(5_000);
import { mkdtemp, rm, mkdir, chmod, unlink } from "node:fs/promises";
import { join, dirname } from "node:path";
import { tmpdir } from "node:os";

Expand All@@ -8,18 +11,26 @@ const tempDir = await mkdtemp(join(tmpdir(), "clerk-cred-test-"));
// Redirect file-based credential storage to temp dir via env var
process.env.CLERK_CONFIG_DIR = tempDir;

// Re-register real credential-store to override any stale mocks from other test files
const isMacOS = process.platform === "darwin";
const KEYCHAIN_SERVICE = "clerk-cli";
const KEYCHAIN_ACCOUNT = "oauth-access-token";
// Import constants from the source module to avoid duplication
const { KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } = await import("./credential-store.ts");
const credFile = () =>
 join(process.env.CLERK_CONFIG_DIR ?? join(require("os").homedir(), ".clerk"), "credentials");

let keyringModule: typeof import("@napi-rs/keyring") | null;
try {
 keyringModule = await import("@napi-rs/keyring");
} catch {
 keyringModule = null;
}

mock.module("./credential-store.ts", () => ({
 KEYCHAIN_SERVICE,
 KEYCHAIN_ACCOUNT,
 async storeToken(token: string) {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return;
 } catch {}
 }
Expand All@@ -29,13 +40,10 @@ mock.module("./credential-store.ts", () => ({
 await chmod(f, 0o600);
 },
 async getToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 return (
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet()
 )
 .text()
 .trim();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {}
 }
 const file = Bun.file(credFile());
Expand All@@ -44,13 +52,17 @@ mock.module("./credential-store.ts", () => ({
 return content.trim() || null;
 },
 async deleteToken() {
 if (isMacOS) {
 if (keyringModule) {
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new keyringModule.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 } catch {}
 }
 const file = Bun.file(credFile());
 if (await file.exists()) await Bun.write(credFile(), "");
 try {
 await unlink(credFile());
 } catch {
 // File doesn't exist, nothing to delete
 }
 },
}));

Expand All@@ -59,8 +71,8 @@ const { storeToken, getToken, deleteToken } = await import("./credential-store.t
let savedToken: string | null = null;

afterAll(async () => {
 // Restore any pre-existing keychain token on macOS
 if (process.platform === "darwin" && savedToken !== null) {
 // Restore any pre-existing keyring token
 if (keyringModule && savedToken !== null) {
 await storeToken(savedToken);
 }
 delete process.env.CLERK_CONFIG_DIR;
Expand All@@ -69,8 +81,8 @@ afterAll(async () => {

describe("credential-store", () => {
 beforeEach(async () => {
 // On first run, save any existing keychain token so we can restore it later
 if (process.platform === "darwin" && savedToken === null) {
 // On first run, save any existing keyring token so we can restore it later
 if (keyringModule && savedToken === null) {
 savedToken = await getToken();
 }
 await deleteToken();
Expand Down

70 changes: 46 additions & 24 deletions
src/lib/credential-store.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
/**
 * Credential store for persisting the OAuth access token.
 * Uses macOS Keychain as primary, falls back to a plaintext file with chmod 600.
 * Uses platform keyring as primary (via @napi-rs/keyring), falls back to a plaintext file with chmod 600.
 */

import { dirname } from "node:path";
import { mkdir, chmod } from "node:fs/promises";
import { CREDENTIALS_FILE, KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT } from "./constants.ts";
import { mkdir, chmod, unlink } from "node:fs/promises";
import { CREDENTIALS_FILE } from "./constants.ts";

const isMacOS = process.platform === "darwin";
export const KEYCHAIN_SERVICE = "clerk-cli";
export const KEYCHAIN_ACCOUNT = "oauth-access-token";

async function keychainStore(token: string): Promise<boolean> {
 if (!isMacOS) return false;
let keyringModule: typeof import("@napi-rs/keyring") | null | undefined;

async function getKeyring(): Promise<typeof import("@napi-rs/keyring") | null> {
 if (keyringModule !== undefined) return keyringModule;
 try {
 // -U flag updates existing entry if present
 await Bun.$`security add-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w ${token} -U`.quiet();
 keyringModule = await import("@napi-rs/keyring");
 return keyringModule;
 } catch {
 keyringModule = null;
 return null;
 }
}

async function keyringStore(token: string): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.setPassword(token);
 return true;
 } catch {
 return false;
 }
}

async function keychainGet(): Promise<string | null> {
 if (!isMacOS) return null;
async function keyringGet(): Promise<string | null> {
 const mod = await getKeyring();
 if (!mod) return null;
 try {
 const result =
 await Bun.$`security find-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE} -w`.quiet();
 return result.text().trim();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 return entry.getPassword();
 } catch {
 return null;
 }
}

async function keychainDelete(): Promise<boolean> {
 if (!isMacOS) return false;
async function keyringDelete(): Promise<boolean> {
 const mod = await getKeyring();
 if (!mod) return false;
 try {
 await Bun.$`security delete-generic-password -a ${KEYCHAIN_ACCOUNT} -s ${KEYCHAIN_SERVICE}`.quiet();
 const entry = new mod.Entry(KEYCHAIN_SERVICE, KEYCHAIN_ACCOUNT);
 entry.deletePassword();
 return true;
 } catch {
 return false;
Expand All@@ -55,17 +72,22 @@ async function fileGet(): Promise<string | null> {
}

async function fileDelete(): Promise<void> {
 const file = Bun.file(CREDENTIALS_FILE);
 if (await file.exists()) {
 await Bun.write(CREDENTIALS_FILE, "");
 try {
 await unlink(CREDENTIALS_FILE);
 } catch {
 // File doesn't exist, nothing to delete
 }
}

export async function storeToken(token: string): Promise<void> {
 const stored = await keychainStore(token);
 if (!stored) {
 await fileStore(token);
 const stored = await keyringStore(token);
 if (stored) {
 // Clean up any stale plaintext credentials from a previous file-based storage
 await fileDelete();
 return;
 }

 await fileStore(token);
}

let tokenOverride: string | null | undefined;
Expand All@@ -77,12 +99,12 @@ export function _setTokenOverride(value: string | null | undefined): void {

export async function getToken(): Promise<string | null> {
 if (tokenOverride !== undefined) return tokenOverride;
 const token = await keychainGet();
 const token = await keyringGet();
 if (token) return token;
 return fileGet();
}

export async function deleteToken(): Promise<void> {
 await keychainDelete();
 await keyringDelete();
 await fileDelete();
}
Loading