auth 1.0.1 → 1.1.0

package/README.md

@@ -1,32 +1,186 @@
-# Auth.js CLI
+<p align="center">
+<img width="96px" src="https://authjs.dev/img/etc/cli.svg" style="margin-right: 16px"/>
+<a href="https://authjs.dev" target="_blank"><img width="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
+  <h1 align="center">Auth.js CLI</h1>
+</p>
+<p align="center">
+  The CLI tool by <a href="https://authjs.dev">Auth.js</a> to supercharge your authentication workflows.
+</p>
+<p align="center">
+  <a href="https://npm.im/auth"><img src="https://img.shields.io/badge/JavaScript-grey?style=flat-square&logo=javascript" alt="JavaScript" /></a>
+  <a href="https://www.npmtrends.com/auth"><img src="https://img.shields.io/npm/dm/auth?style=flat-square&color=cyan" alt="Downloads" /></a>
+  <a href="https://www.npmjs.com/package/auth"><img src="https://img.shields.io/npm/v/auth?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
+  <a href="https://github.com/nextauthjs/cli/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/cli?style=flat-square&color=orange" alt="Github Stars" /></a>
+</p>
 
-The CLI tool by [Auth.js](https://authjs.dev) to supercharge your authentication workflow.
+## Features
+
+- Natural language search to answer questions about Auth.js, docs, APIs, or general auth concepts
+- Initialize new projects with Auth.js for any of the supported frameworks
+- Guides you through adding authentication providers to your existing project
+- ... and more coming soon!
 
 ## Installation
 
-You don't need to install this package, run any of the following commands:
+You don't need to install this package, run the following:
 
 ```sh
-npx auth
+npx auth # or pnpx, bunx, yarn dlx, etc.
 ```
 
 ## Usage
 
-<!-- TODO: Generate by running `node index.js --help` and writing this -->
+<!-- GENERATED START -->
 
-```sh
+```
 Usage: auth [options] [command]
 
 Options:
-  -V, --version          output the version number
-  -h, --help             display help for command
+  -V, --version               output the version number
+  -h, --help                  display help for command
 
 Commands:
-  secret [options]       Generate a random string.
-  framework [framework]  Clone a framework template.
-  help [command]         display help for command
+  ask [options]               Ask about docs, API, or auth concepts.
+  init [options] [framework]  Initialize a project.
+  secret [options]            Generate a random string and add it to the .env
+                              file.
+  add [provider]              Register a new authentication provider
+  help [command]              display help for command
 ```
 
+<!-- GENERATED END -->
+
+## Security
+
+If you think you have found a vulnerability (or are not sure) in Auth.js or any of the related packages (i.e. Adapters), we ask you to read our [Security Policy](https://authjs.dev/security) to reach out responsibly. Please do not open Pull Requests/Issues/Discussions before consulting with us.
+
 ## Acknowledgements
 
 Special thanks to Craig for the `auth` package name on npm.
+
+### Sponsors
+
+We have an [OpenCollective](https://opencollective.com/nextauth) for companies and individuals looking to contribute financially to the project!
+
+<!--sponsors start-->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top">
+        <a href="https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=authjs&utm_content=sponsor" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/49538330?s=200&v=4" alt="Clerk Logo" />
+        </a><br />
+        <div>Clerk</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://fusionauth.io" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/41974756?s=200&v=4" alt="FusionAuth Logo" />
+        </a><br />
+        <div>FusionAuth</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://www.beyondidentity.com" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/69811361?s=200&v=4" alt="Beyond Identity Logo" />
+        </a><br />
+        <div>Beyond Identity</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://stytch.com" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/69983493?s=200&v=4" alt="Stytch Logo" />
+        </a><br />
+        <div>Stytch</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://prisma.io" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/17219288?s=200&v=4" alt="Prisma Logo" />
+        </a><br />
+        <div>Prisma</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://lowdefy.com" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/47087496?s=200&v=4" alt="Lowdefy Logo" />
+        </a><br />
+        <div>Lowdefy</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://www.descope.com" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/97479186?s=200&v=4" alt="Descope Logo" />
+        </a><br />
+        <div>Descope</div>
+        <sub>💵</sub>
+      </td>
+    </tr>
+    <tr>
+      <td align="center" valign="top">
+        <a href="https://badass.dev" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/136839242?v=4" alt="Badass Courses Logo" />
+        </a><br />
+        <div>Badass Courses</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://github.com/encoredev/encore" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/50438175?v=4" alt="Encore Logo" />
+        </a><br />
+        <div>Encore</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://arcjet.com/" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/24397786?s=200&v=4" alt="Arcjet Logo" />
+        </a><br />
+        <div>Arcjet</div>
+        <sub>💵</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://checklyhq.com" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/25982255?s=200&v=4" alt="Checkly Logo" />
+        </a><br />
+        <div>Checkly</div>
+        <sub>☁️</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://superblog.ai/" target="_blank">
+          <img width="108" src="https://d33wubrfki0l68.cloudfront.net/cdc4a3833bd878933fcc131655878dbf226ac1c5/10cd6/images/logo_bolt_small.png" alt="superblog Logo" />
+        </a><br />
+        <div>superblog</div>
+        <sub>☁️</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://www.netlight.com/" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/1672348?s=200&v=4" alt="Netlight logo" />
+        </a><br />
+        <div>Netlight</div>
+        <sub>☁️</sub>
+      </td>
+      <td align="center" valign="top">
+        <a href="https://vercel.com" target="_blank">
+          <img width="108" src="https://avatars.githubusercontent.com/u/14985020?s=200&v=4" alt="Vercel Logo" />
+        </a><br />
+        <div>Vercel</div>
+        <sub>☁️</sub>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+- 💵 Financial Sponsor
+- ☁️ Infrastructure Support
+
+<br />
+<!--sponsors end-->
+
+## Contributing
+
+We're open to all community contributions! If you'd like to contribute in any way, please first read
+our [Contributing Guide](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md).
+
+## License
+
+MIT

package/commands/add.js

@@ -0,0 +1,117 @@
+// @ts-check
+
+import * as y from "yoctocolors"
+import open from "open"
+import clipboard from "clipboardy"
+import { select, input, password } from "@inquirer/prompts"
+import { requireFramework } from "../lib/detect.js"
+import { updateEnvFile } from "../lib/write-env.js"
+import { providers, frameworks } from "../lib/meta.js"
+import { secret } from "./index.js"
+import { link, markdownToAnsi } from "../lib/markdown.js"
+
+const choices = Object.entries(providers)
+  .filter(([, { setupUrl }]) => !!setupUrl)
+  .map(([value, { name }]) => ({ name, value }))
+
+/** @param {string | undefined} providerId */
+export async function action(providerId) {
+  try {
+    if (!providerId) {
+      providerId = await select({
+        message: "What provider do you want to set up?",
+        choices: choices,
+      })
+    }
+
+    const provider = providers[providerId]
+    if (!provider?.setupUrl) {
+      console.error(
+        y.red(
+          `Missing instructions for ${
+            provider?.name ?? providerId
+          }.\nInstructions are available for: ${y.bold(
+            choices.map((choice) => choice.name).join(", ")
+          )}`
+        )
+      )
+      return
+    }
+
+    const frameworkId = await requireFramework()
+    const framework = frameworks[frameworkId]
+
+    console.log(
+      y.dim(
+        `Setting up OAuth provider in your ${framework.name} app (${link(
+          "more info",
+          "https://authjs.dev/getting-started/authentication/oauth"
+        )})...\n`
+      )
+    )
+
+    const url = new URL(
+      `${framework.path}/callback/${providerId}`,
+      `http://localhost:${framework.port}`
+    )
+
+    clipboard.writeSync(url.toString())
+    console.log(
+      `\
+${y.bold("Setup URL")}: ${provider.setupUrl}
+${y.bold("Callback URL (copied to clipboard)")}: ${url}`
+    )
+
+    console.log("_________________________")
+    if (provider.instructions) {
+      console.log(y.dim("\nFollow the instructions:\n"))
+      console.log(markdownToAnsi(provider.instructions))
+    }
+    console.log(
+      y.dim(
+        `\nProvider documentation: https://providers.authjs.dev/${providerId}\n`
+      )
+    )
+    console.log("‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾")
+    console.log(y.dim("Opening setup URL in your browser...\n"))
+    await new Promise((resolve) => setTimeout(resolve, 3000))
+
+    await open(provider.setupUrl)
+
+    const clientId = await input({
+      message: `Paste ${y.magenta("Client ID")}:`,
+      validate: (value) => !!value,
+    })
+    const clientSecret = await password({
+      message: `Paste ${y.magenta("Client secret")}:`,
+      mask: true,
+      validate: (value) => !!value,
+    })
+
+    console.log(y.dim(`Updating environment variable file...`))
+
+    const varPrefix = `AUTH_${providerId.toUpperCase()}`
+
+    await updateEnvFile({
+      [`${varPrefix}_ID`]: clientId,
+      [`${varPrefix}_SECRET`]: clientSecret,
+    })
+
+    console.log(
+      y.dim(
+        `\nEnsuring that ${link(
+          "AUTH_SECRET",
+          "https://authjs.dev/getting-started/installation#setup-environment"
+        )} is set...`
+      )
+    )
+
+    await secret.action({})
+
+    console.log("\n🎉 Done! You can now use this provider in your app.")
+  } catch (error) {
+    if (!(error instanceof Error)) return
+    if (error.message.startsWith("User force closed")) return
+    throw error
+  }
+}

package/commands/ask.js

@@ -0,0 +1,90 @@
+// @ts-check
+
+import * as y from "yoctocolors"
+import { input } from "@inquirer/prompts"
+import { InkeepAI } from "@inkeep/ai-api"
+import { ChatModeOptions } from "@inkeep/ai-api/models/components/index.js"
+import * as ora from "ora"
+import { link, markdownToAnsi, breakStringToLines } from "../lib/markdown.js"
+
+const INKEEP_API_KEY = "e32967a320a48a2cd933922099e1f38f6ebb4ab62ff98343"
+const INKEEP_INTEGRATION_ID = "clvn0fdez000cip0e5w2oaobw"
+
+const inkeepAI = new InkeepAI({ apiKey: INKEEP_API_KEY })
+
+function randomSpinner() {
+  const allSpinners = Object.keys(ora.spinners)
+  const max = allSpinners.length - 1
+  const random = Math.floor(Math.random() * (max + 1))
+  return allSpinners[random]
+}
+
+export async function action({ stream = false, raw = false }) {
+  const format = raw ? (i) => i : markdownToAnsi
+  const newLocal = randomSpinner()
+  const spinner = ora.default({
+    text: "Understanding question",
+    // @ts-expect-error
+    spinner: newLocal,
+  })
+  try {
+    const content = await input({ message: "What would you like to know: " })
+
+    spinner.start()
+
+    const result = await inkeepAI.chatSession.create({
+      integrationId: INKEEP_INTEGRATION_ID,
+      stream,
+      chatSession: { messages: [{ content, role: "user" }] },
+      chatMode: ChatModeOptions.Auto,
+    })
+
+    if (stream) {
+      if (result.chatResultStream == null) {
+        throw new Error("failed to create stream: received null value")
+      }
+
+      spinner.stop().clear()
+
+      for await (const event of result.chatResultStream) {
+        if (event.event === "message_chunk") {
+          const content = format(event.data.contentChunk)
+          process.stdout.write(content)
+        }
+      }
+    } else {
+      const answer = result.chatResult?.message.content
+      if (!answer) return console.error(y.red("Could not get an answer."))
+
+      console.log(breakStringToLines(format(answer), 80))
+    }
+
+    console.log(
+      y.italic(
+        `\n\nAnswered by ${y.cyan(
+          link("Inkeep AI", "https://inkeep.com")
+        )}. Check out the official ${y.magenta(
+          link("Auth.js", "https://authjs.dev")
+        )} docs.`
+      )
+    )
+  } catch (e) {
+    spinner.stop().clear()
+    if (!(e instanceof Error)) return
+    if (e.message.startsWith("User force closed")) return
+
+    console.error(y.red(e.stack ?? e.message))
+    console.error(
+      y.bold(
+        y.red(
+          `\n This is a bug. Please report it on ${link(
+            "GitHub",
+            "https://github.com/nextauthjs/auth-cli/issues"
+          )}.`
+        )
+      )
+    )
+  } finally {
+    spinner.stop().clear()
+  }
+}

package/commands/index.js

@@ -0,0 +1,4 @@
+export * as ask from "./ask.js"
+export * as init from "./init.js"
+export * as secret from "./secret.js"
+export * as add from './add.js'

package/commands/init.js

@@ -0,0 +1,121 @@
+// @ts-check
+import { execSync } from "node:child_process"
+import { input, confirm, select, checkbox } from "@inquirer/prompts"
+import * as y from "yoctocolors"
+import { action as secretAction } from "./secret.js"
+
+import { getPkgManager, install } from "../lib/pkg-manager.js"
+import * as meta from "../lib/meta.js"
+import { updateEnvFile } from "../lib/write-env.js"
+import { mkdir } from "node:fs/promises"
+
+/**
+ * @param {string} framework
+ * @param {{example?: boolean}} options
+ * @returns
+ */
+export async function action(framework, options) {
+  try {
+    if (!framework) {
+      framework = await select({
+        message: "Select a framework",
+        choices: Object.entries(meta.frameworks).map(([key, value]) => ({
+          name: `${value.name} ${y.dim(`(${key})`)}`,
+          value: key,
+        })),
+      })
+    }
+
+    const dir = await input({
+      message: "Name of the project",
+      default: `my-${framework}-app`,
+    })
+
+    if (options.example) await createFromExample(framework, dir)
+
+    const providers = await checkbox({
+      instructions: false,
+      message: "Select one or multiple providers",
+      choices: Object.entries(meta.providers).map(([value, { name }]) => ({
+        name,
+        value,
+      })),
+    })
+
+    /** @type {string|undefined} */
+    let adapter = await select({
+      default: "none",
+      message: "Select a database adapter",
+      choices: Object.entries(meta.adapters).map(([value, name]) => ({
+        name,
+        value,
+      })),
+    })
+    adapter = adapter === "none" ? undefined : adapter
+
+    await scaffoldProject({ framework, dir, providers, adapter })
+  } catch (e) {
+    if (!(e instanceof Error)) return
+    if (e.message.startsWith("User force closed")) return
+
+    console.error(y.red(e.message))
+  }
+}
+
+/**
+ * @param {string} framework
+ * @param {string} dir
+ */
+async function createFromExample(framework, dir) {
+  const { src, demo } = meta.frameworks[framework]
+  execSync(`git clone ${src} ${dir}`)
+  if (
+    await confirm({
+      message: "Initiailze .env with `AUTH_SECRET`",
+      default: true,
+    })
+  ) {
+    execSync(`cd ${dir}`)
+    await secretAction({ path: dir })
+  }
+
+  await install()
+
+  console.log(`
+  Project ${y.italic(`\`${dir}\``)} has been created.
+  Source code: ${src}
+  Deployed demo: ${demo}`)
+}
+
+/**
+ * @param {{framework: string, dir: string, providers: string[], adapter?: string}} options
+ */
+async function scaffoldProject(options) {
+  const { framework, providers, dir, adapter } = options
+  const pkgManager = getPkgManager()
+  console.log(
+    `Scaffolding ${y.bold(framework)} project with ${y.bold(
+      pkgManager
+    )} at ${y.bold(dir)}...`
+  )
+  throw new Error("Scaffolding not implemented. Please use `init --example`")
+  console.log(`Create directory ${dir}`)
+  await mkdir(dir)
+  console.log(`Change directory to ${dir}`)
+  execSync(`cd ${dir}`)
+  console.log(`Initialize ${pkgManager} project`)
+  execSync(`${pkgManager} init`)
+  // console.log(`Add ${framework} to ${pkgManager}`)
+  // execSync(`${pkgManager} install ${framework}`)
+  for (const provider of providers) {
+    const id = `AUTH_${provider.toUpperCase()}_ID`
+    const secret = `AUTH_${provider.toUpperCase()}_SECRET`
+    await updateEnvFile(
+      {
+        [id]: "",
+        [secret]: "",
+      },
+      dir
+    )
+  }
+}

package/commands/secret.js

@@ -0,0 +1,55 @@
+// @ts-check
+
+import * as y from "yoctocolors"
+import clipboard from "clipboardy"
+import { requireFramework } from "../lib/detect.js"
+import { updateEnvFile } from "../lib/write-env.js"
+
+/** Web compatible method to create a random string of a given length */
+function randomString(size = 32) {
+  const bytes = crypto.getRandomValues(new Uint8Array(size))
+  // @ts-expect-error
+  return Buffer.from(bytes, "base64").toString("base64")
+}
+
+/**
+ * @param {{
+ *  copy?: boolean
+ *  path?: string
+ *  raw?: boolean
+ * }} options
+ */
+export async function action(options) {
+  const key = "AUTH_SECRET"
+  const value = randomString()
+  if (options.raw) return console.log(value)
+
+  const line = `${key}="${value}"`
+  const message = {
+    introClipboard:
+      "Secret generated. It has been copied to your clipboard, paste it to your .env/.env.local file to continue.",
+    introCopy:
+      "Secret generated. Copy it to your .env/.env.local file (depending on your framework):",
+    value: `\n${line}`,
+  }
+
+  if (options.copy) {
+    try {
+      clipboard.writeSync(line)
+      console.log(message.introClipboard)
+    } catch (error) {
+      console.error(y.red(error))
+      console.log(message.introCopy)
+    } finally {
+      console.log(message.value)
+      process.exit(0)
+    }
+  }
+
+  try {
+    await requireFramework(options.path)
+    await updateEnvFile({ [key]: value }, options.path, true)
+  } catch (error) {
+    console.error(y.red(error))
+  }
+}

package/index.js

@@ -1,78 +1,63 @@
-import { InvalidArgumentError } from "commander"
-import { Command } from "commander"
+#!/usr/bin/env node
+
+// @ts-check
+
+import { Command, InvalidArgumentError } from "commander"
+import * as y from "yoctocolors"
+import { ask, init, secret, add } from "./commands/index.js"
+
 // import pkg from "./package.json" assert { type: "json" }
 
-import fs from "fs/promises"
-import { join } from "path"
-import { fileURLToPath } from "url"
+import fs from "node:fs/promises"
+import { join } from "node:path"
+import { fileURLToPath } from "node:url"
+
 const __dirname = fileURLToPath(new URL(".", import.meta.url))
-const pkg = JSON.parse(await fs.readFile(join(__dirname, "./package.json")))
+const pkg = JSON.parse(
+  await fs.readFile(join(__dirname, "./package.json"), "utf-8")
+)
 const { name, description, version } = pkg
 
 try {
   // TODO: Remove when Node.js 18 is not maintained anymore
+  // @ts-expect-error
   globalThis.crypto ??= (await import("crypto")).webcrypto
 } catch {}
 
-/** Web compatible method to create a random string of a given length */
-export function randomString(size = 32) {
-  const bytes = crypto.getRandomValues(new Uint8Array(size))
-  return Buffer.from(bytes, "base64").toString("base64")
-}
-
 const program = new Command()
 
-program.name(name).description(description).version(version)
+program
+  .name(name)
+  .description(description.replace("Auth.js", y.magenta(y.bold("Auth.js"))))
+  .version(version)
 
 program
-  .command("secret")
-  .option("--raw", "Output the string without any formatting.")
-  .description("Generate a random string.")
-  .action((options) => {
-    const value = randomString()
-    if (options.raw) return console.log(value)
-    // TODO: Detect framework, check for existing value, and write automatically
-    console.log(`
-Secret generated. Copy it to your .env/.env.local file (depending on your framework):
+  .command("ask")
+  .option("--stream", "Stream the response.")
+  .option("--raw", "Show the Markdown response without formatting.")
+  .description("Ask about docs, API, or auth concepts.")
+  .action(ask.action)
 
-AUTH_SECRET=${value}`)
-  })
+program
+  .command("init")
+  .argument("[framework]", "The framework to use.")
+  .option("-e, --example", "Clone a full example.")
+  .description("Initialize a project.")
+  .action(init.action)
 
-// TODO: Get this programmatically
-const frameworks = {
-  nextjs: {
-    src: "https://github.com/nextauthjs/next-auth-example",
-    demo: "https://next-auth-example.vercel.app",
-  },
-  sveltekit: {
-    src: "https://github.com/nextauthjs/sveltekit-auth-example",
-    demo: "https://sveltekit-auth-example.vercel.app",
-  },
-  express: {
-    src: "https://github.com/nextauthjs/express-auth-example",
-    demo: "https://express-auth-example.vercel.app",
-  },
-}
+program
+  .command("secret")
+  .option("--raw", "Output the string without any formatting.")
+  .option("--copy", 'Copy AUTH_SECRET="value".')
+  .description("Generate a random string and add it to the .env file.")
+  .action(secret.action)
 
 program
-  .command("framework")
-  .argument("[framework]", "The framework to use.", (value) => {
-    if (!value) return value
-    if (Object.keys(frameworks).includes(value)) return value
-    throw new InvalidArgumentError(
-      `Valid frameworks are: ${supportedFrameworks.join(", ")}`
-    )
-  })
-  .description("Clone a framework template.")
-  .action((framework) => {
-    if (!framework) {
-      return console.log(`
-Supported frameworks are: ${Object.keys(frameworks).join(", ")}`)
-    }
-    const { src, demo } = frameworks[framework]
-    console.log(`
-Source code: ${src}
-Deployed demo: ${demo}`)
-  })
+  .command("add")
+  .argument("[provider]", "The authentication provider.")
+  .description('Register a new authentication provider')
+  .action(add.action)
+
+program.parse()
 
-program.parse(process.argv)
+export { program }

package/lib/detect.js

@@ -0,0 +1,56 @@
+// @ts-check
+import { readFile } from "node:fs/promises"
+import { join } from "node:path"
+import { frameworks } from "../lib/meta.js"
+import * as y from "yoctocolors"
+
+/**
+ * When this function runs in a framework directory we support,
+ * it will return the framework's name
+ * @param {string} path
+ * @returns {Promise<import("./meta").SupportedFramework | "unknown">}
+ */
+export async function detectFramework(path = "") {
+  const dir = process.cwd()
+  const packageJsonPath = join(dir, path, "package.json")
+  try {
+    const packageJson = JSON.parse(await readFile(packageJsonPath, "utf-8"))
+
+    /** @type {import("./meta").SupportedFramework[]} */
+    const foundFrameworks = []
+
+    if (packageJson.dependencies["next"]) foundFrameworks.push("next")
+    if (packageJson.dependencies["express"]) foundFrameworks.push("express")
+    if (packageJson.devDependencies["@sveltejs/kit"])
+      foundFrameworks.push("sveltekit")
+
+    if (foundFrameworks.length === 1) return foundFrameworks[0]
+
+    if (foundFrameworks.length > 1) {
+      console.error(
+        `Multiple supported frameworks detected: ${foundFrameworks.join(", ")}`
+      )
+      return "unknown"
+    }
+    return "unknown"
+  } catch {
+    return "unknown"
+  }
+}
+
+export async function requireFramework(path = "") {
+  const framework = await detectFramework(path)
+
+  if (framework === "unknown") {
+    console.error(
+      y.red(`No framework detected. Currently supported frameworks are: ${y.bold(
+        Object.keys(frameworks).join(", ")
+      )}`)
+    )
+
+    process.exit(0)
+  }
+
+  return framework
+}
+

package/lib/is-online.js

@@ -0,0 +1,46 @@
+// @ts-check
+
+import { execSync } from "node:child_process"
+import dns from "node:dns/promises"
+
+function getProxy() {
+  if (process.env.https_proxy) {
+    return process.env.https_proxy
+  }
+
+  try {
+    const httpsProxy = execSync("npm config get https-proxy").toString().trim()
+    return httpsProxy !== "null" ? httpsProxy : undefined
+  } catch (e) {
+    return
+  }
+}
+
+export async function getOnline() {
+  try {
+    await dns.lookup("registry.yarnpkg.com")
+    // If DNS lookup succeeds, we are online
+    return true
+  } catch {
+    // The DNS lookup failed, but we are still fine as long as a proxy has been set
+    const proxy = getProxy()
+    if (!proxy) {
+      return false
+    }
+
+    const { hostname } = new URL(proxy)
+    if (!hostname) {
+      // Invalid proxy URL
+      return false
+    }
+
+    try {
+      await dns.lookup(hostname)
+      // If DNS lookup succeeds for the proxy server, we are online
+      return true
+    } catch {
+      // The DNS lookup for the proxy server also failed, so we are offline
+      return false
+    }
+  }
+}

package/lib/markdown.js

@@ -0,0 +1,59 @@
+// @ts-check
+import * as y from "yoctocolors"
+
+// double char markdown matchers
+const BOLD_REGEX = /\*{2}([^*]+)\*{2}/g
+const UNDERLINE_REGEX = /_{2}([^_]+)_{2}/g
+const STRIKETHROUGH_REGEX = /~{2}([^~]+)~{2}/g
+const LINK_REGEX = /\[([^\]]+)\]\(([^)]+)\)/g
+
+// single char markdown matchers
+const ITALIC_REGEX = /(?<!\\)\*(.+)(?<!\\)\*|(?<!\\)_(.+)(?<!\\)_/g
+
+export function link(text, url) {
+  return `\x1b]8;;${url}\x1b\\${text}\x1b]8;;\x1b\\`
+}
+
+/**
+ * @param {string} input
+ * @returns {string}
+ */
+export function markdownToAnsi(input) {
+  input = input.replace(BOLD_REGEX, (...args) => y.bold(args[1]))
+  input = input.replace(UNDERLINE_REGEX, (...args) => y.underline(args[1]))
+  input = input.replace(STRIKETHROUGH_REGEX, (...args) =>
+    y.strikethrough(args[1])
+  )
+  input = input.replace(ITALIC_REGEX, (...args) => y.italic(args[1] || args[2]))
+  input = input.replace(/(?<!\\)\\/g, "")
+
+  // @ts-expect-error
+  input = input.replaceAll(LINK_REGEX, (...args) =>
+    y.blue(" " + link(args[2], args[1]))
+  )
+  return input
+}
+
+/**
+ * @param {string} str
+ * @param {number} maxLineLength
+ * @returns {string}
+ */
+export function breakStringToLines(str, maxLineLength) {
+  let result = ""
+  let line = ""
+
+  str.split(" ").forEach((word) => {
+    if (line.length + word.length + 1 > maxLineLength) {
+      result += line + "\n"
+      line = word
+    } else {
+      if (line) line += " "
+      line += word
+    }
+  })
+
+  if (line) result += line
+
+  return result
+}

package/lib/meta.js

@@ -0,0 +1,173 @@
+// @ts-check
+
+// TODO: Get these programmatically
+
+/**
+ * @typedef {"next" | "express" | "sveltekit"} SupportedFramework
+ */
+
+export const frameworks = {
+  next: {
+    name: "Next.js",
+    src: "https://github.com/nextauthjs/next-auth-example",
+    demo: "https://next-auth-example.vercel.app",
+    path: "/api/auth",
+    port: 3000,
+    envFile: ".env.local",
+  },
+  sveltekit: {
+    name: "SvelteKit",
+    src: "https://github.com/nextauthjs/sveltekit-auth-example",
+    demo: "https://sveltekit-auth-example.vercel.app",
+    path: "/auth",
+    port: 5173,
+    envFile: ".env",
+  },
+  express: {
+    name: "Express",
+    src: "https://github.com/nextauthjs/express-auth-example",
+    demo: "https://express-auth-example.vercel.app",
+    path: "/auth",
+    port: 3000,
+    envFile: ".env",
+  },
+}
+
+export const providers = {
+  "42-school": { name: "42 School", setupUrl: undefined },
+  apple: {
+    name: "Apple",
+    setupUrl:
+      "https://developer.apple.com/account/resources/identifiers/list/serviceId",
+  },
+  asgardeo: { name: "Asgardeo", setupUrl: undefined },
+  auth0: { name: "Auth0", setupUrl: undefined },
+  authentik: { name: "Authentik", setupUrl: undefined },
+  "azure-ad-b2c": { name: "Azure AD B2C", setupUrl: undefined },
+  "azure-ad": { name: "Azure AD", setupUrl: undefined },
+  "azure-devops": { name: "Azure DevOps", setupUrl: undefined },
+  battlenet: { name: "Battlenet", setupUrl: undefined },
+  beyondidentity: { name: "Beyond Identity", setupUrl: undefined },
+  box: { name: "Box", setupUrl: undefined },
+  "boxyhq-saml": { name: "Boxyhq SAML", setupUrl: undefined },
+  bungie: { name: "Bungie", setupUrl: undefined },
+  "click-up": { name: "Click-up", setupUrl: undefined },
+  cognito: { name: "Cognito", setupUrl: undefined },
+  coinbase: { name: "Coinbase", setupUrl: undefined },
+  credentials: { name: "Credentials", setupUrl: undefined },
+  descope: { name: "Descope", setupUrl: undefined },
+  discord: { name: "Discord", setupUrl: undefined },
+  dribbble: { name: "Dribbble", setupUrl: undefined },
+  dropbox: { name: "Dropbox", setupUrl: undefined },
+  "duende-identity-server6": {
+    name: "Duende Identity Server 6",
+    setupUrl: undefined,
+  },
+  email: { name: "Email", setupUrl: undefined },
+  eveonline: { name: "Eveonline", setupUrl: undefined },
+  facebook: { name: "Facebook", setupUrl: undefined },
+  faceit: { name: "Faceit", setupUrl: undefined },
+  foursquare: { name: "Foursquare", setupUrl: undefined },
+  freshbooks: { name: "Freshbooks", setupUrl: undefined },
+  fusionauth: { name: "FusionAuth", setupUrl: undefined },
+  github: {
+    name: "GitHub",
+    setupUrl: "https://github.com/settings/applications/new",
+    instructions: `\
+1. Set *Application name* (can be anything)
+2. Set *Homepage URL* (your business/website, but can be anything)
+3. Paste the redirect URI (on your clipboard) to *Authorization callback URL*
+4. Click *Register application*
+5. Paste the *Client ID* back here
+6. Click *Generate a new client secret*
+7. Paste the *Client secret* back here (Note: This is the only time you can see it)`,
+  },
+  gitlab: { name: "GitLab", setupUrl: undefined },
+  google: {
+    name: "Google",
+    setupUrl: "https://console.cloud.google.com/apis/credentials/oauthclient",
+    instructions: `\
+1. Choose *Application Type: Web Application*
+2. Paste the redirect URI (on your clipboard) to *Authorized redirect URIs*
+3. Fill out the rest of the form
+4. Click *Create*`,
+  },
+  hubspot: { name: "Hubspot", setupUrl: undefined },
+  "identity-server4": { name: "Identity Server 4", setupUrl: undefined },
+  instagram: { name: "Instagram", setupUrl: undefined },
+  kakao: { name: "Kakao", setupUrl: undefined },
+  keycloak: { name: "Keycloak", setupUrl: undefined },
+  line: { name: "Line", setupUrl: undefined },
+  linkedin: { name: "LinkedIn", setupUrl: undefined },
+  mailchimp: { name: "Mailchimp", setupUrl: undefined },
+  mailru: { name: "Mail.ru", setupUrl: undefined },
+  mastodon: { name: "Mastodon", setupUrl: undefined },
+  mattermost: { name: "Mattermost", setupUrl: undefined },
+  medium: { name: "Medium", setupUrl: undefined },
+  "microsoft-entra-id": { name: "Microsoft Entra ID", setupUrl: undefined },
+  naver: { name: "Naver", setupUrl: undefined },
+  netlify: { name: "Netlify", setupUrl: undefined },
+  netsuite: { name: "Netsuite", setupUrl: undefined },
+  nodemailer: { name: "Nodemailer", setupUrl: undefined },
+  notion: { name: "Notion", setupUrl: undefined },
+  okta: { name: "Okta", setupUrl: undefined },
+  onelogin: { name: "Onelogin", setupUrl: undefined },
+  "ory-hydra": { name: "Ory Hydra", setupUrl: undefined },
+  osso: { name: "Osso", setupUrl: undefined },
+  osu: { name: "Osu", setupUrl: undefined },
+  passage: { name: "Passage", setupUrl: undefined },
+  passkey: { name: "Passkey", setupUrl: undefined },
+  patreon: { name: "Patreon", setupUrl: undefined },
+  pinterest: { name: "Pinterest", setupUrl: undefined },
+  pipedrive: { name: "Pipedrive", setupUrl: undefined },
+  postmark: { name: "Postmark", setupUrl: undefined },
+  reddit: { name: "Reddit", setupUrl: undefined },
+  resend: { name: "Resend", setupUrl: undefined },
+  salesforce: { name: "Salesforce", setupUrl: undefined },
+  sendgrid: { name: "Sendgrid", setupUrl: undefined },
+  slack: { name: "Slack", setupUrl: undefined },
+  spotify: { name: "Spotify", setupUrl: undefined },
+  strava: { name: "Strava", setupUrl: undefined },
+  tiktok: { name: "Tiktok", setupUrl: undefined },
+  todoist: { name: "Todoist", setupUrl: undefined },
+  trakt: { name: "Trakt", setupUrl: undefined },
+  twitch: { name: "Twitch", setupUrl: undefined },
+  twitter: { name: "Twitter", setupUrl: undefined },
+  "united-effects": { name: "United Effects", setupUrl: undefined },
+  vk: { name: "Vk", setupUrl: undefined },
+  webex: { name: "Webex", setupUrl: undefined },
+  wikimedia: { name: "Wikimedia", setupUrl: undefined },
+  wordpress: { name: "Wordpress", setupUrl: undefined },
+  workos: { name: "WorkOS", setupUrl: undefined },
+  yandex: { name: "Yandex", setupUrl: undefined },
+  zitadel: { name: "Zitadel", setupUrl: undefined },
+  zoho: { name: "Zoho", setupUrl: undefined },
+  zoom: { name: "Zoom", setupUrl: undefined },
+}
+
+export const adapters = {
+  none: "None",
+  "adapter-azure-tables": "Azure Tables",
+  d1: "d1",
+  dgraph: "Dgraph",
+  drizzle: "Drizzle",
+  dynamodb: "DynamoDB",
+  edgedb: "EdgeDB",
+  fauna: "Fauna",
+  firebase: "Firebase",
+  hasura: "Hasura",
+  kysely: "Kysely",
+  "mikro-orm": "MikroORM",
+  mongodb: "MongoDB",
+  neo4j: "Neo4j",
+  pg: "PostgreSQL",
+  pouchdb: "PouchDB",
+  prisma: "Prisma",
+  sequelize: "Sequelize",
+  supabase: "Supabase",
+  surrealdb: "SurrealDB",
+  typeorm: "TypeORM",
+  unstorage: "Unstorage",
+  "upstash-redis": "Upstash Redis",
+  xata: "Xata",
+}

package/lib/pkg-manager.js

@@ -0,0 +1,70 @@
+// @ts-check
+
+import { yellow } from "yoctocolors"
+import { spawn } from "node:child_process"
+import { getOnline } from "./is-online.js"
+
+/**
+ * @typedef {'npm' | 'pnpm' | 'yarn' | 'bun'} PackageManager
+ */
+
+/**
+ * @source https://github.com/vercel/next.js/blob/canary/packages/create-next-app/helpers/get-pkg-manager.ts
+ * @returns {PackageManager}
+ */
+export function getPkgManager() {
+  const userAgent = process.env.npm_config_user_agent || ""
+
+  if (userAgent.startsWith("pnpm")) {
+    return "pnpm"
+  }
+
+  if (userAgent.startsWith("bun")) {
+    return "bun"
+  }
+
+  if (userAgent.startsWith("yarn")) {
+    return "yarn"
+  }
+
+  return "npm"
+}
+
+/**
+ * @source https://github.com/vercel/next.js/blob/canary/packages/create-next-app/helpers/install.ts
+ * Spawn a package manager installation based on user preference.
+ *
+ * @returns A Promise that resolves once the installation is finished.
+ */
+export async function install() {
+  const packageManager = getPkgManager()
+  /** @type {string[]} */
+  const args = ["install"]
+  if (!(await getOnline())) {
+    console.log(
+      yellow("You appear to be offline.\nFalling back to the local cache.")
+    )
+    args.push("--offline")
+  }
+  return new Promise((resolve, reject) => {
+    /** Spawn the installation process. */
+    const child = spawn(packageManager, args, {
+      stdio: "inherit",
+      env: {
+        ...process.env,
+        ADBLOCK: "1",
+        // we set NODE_ENV to development as pnpm skips dev
+        // dependencies when production
+        NODE_ENV: "development",
+        DISABLE_OPENCOLLECTIVE: "1",
+      },
+    })
+    child.on("close", (code) => {
+      if (code !== 0) {
+        reject({ command: `${packageManager} ${args.join(" ")}` })
+        return
+      }
+      resolve(void 0)
+    })
+  })
+}

package/lib/write-env.js

@@ -0,0 +1,61 @@
+// @ts-check
+
+import * as y from "yoctocolors"
+import { readFile, writeFile } from "node:fs/promises"
+import prompt from "prompts"
+import { join } from "node:path"
+import { frameworks } from "./meta.js"
+import { detectFramework } from "./detect.js"
+
+/**
+ * Add/update key-value pair(s) to a .env file
+ * @param {Record<string, string>} env
+ * @param {string|undefined} envPath
+ * @param {boolean} comment
+ */
+export async function updateEnvFile(env, envPath = "", comment = false) {
+  const framework = await detectFramework(envPath)
+  const dotEnvFile = frameworks[framework]?.envFile
+  const file = join(process.cwd(), envPath, dotEnvFile)
+  let content = ""
+  let read = false
+  let created = false
+  for (const [key, value] of Object.entries(env)) {
+    const line = `${key}="${value}"${
+      comment ? " # Added by `npx auth`. Read more: https://cli.authjs.dev" : ""
+    }`
+    try {
+      if (!read) {
+        content = await readFile(file, "utf-8")
+        read = true
+      }
+      if (!content.includes(`${key}=`)) {
+        console.log(`➕ Added \`${key}\` to ${y.italic(file)}.`)
+        content = content ? `${content}\n${line}` : line
+      } else {
+        const { overwrite } = await prompt({
+          type: "confirm",
+          name: "overwrite",
+          message: `Overwrite existing \`${key}\`?`,
+          initial: false,
+        })
+        if (!overwrite) continue
+        console.log(`✨ Updated \`${key}\` in ${y.italic(file)}.`)
+        content = content.replace(new RegExp(`${key}=(.*)`), `${line}`)
+      }
+    } catch (error) {
+      if (error.code === "ENOENT") {
+        if (!created) {
+          console.log(`📝 Created ${y.italic(file)} with \`${key}\`.`)
+          created = true
+        } else {
+          console.log(`➕ Added \`${key}\` to ${y.italic(file)}.`)
+        }
+        content = content ? `${content}\n${line}` : line
+      } else {
+        throw error
+      }
+    }
+  }
+  if (content) await writeFile(file, content)
+}

package/package.json

@@ -1,8 +1,20 @@
 {
   "name": "auth",
-  "description": "The CLI tool by Auth.js to supercharge your authentication workflow.",
+  "version": "1.1.0",
   "homepage": "https://cli.authjs.dev",
-  "version": "1.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nextauthjs/auth-cli.git"
+  },
+  "description": "The CLI tool by Auth.js to supercharge your authentication workflows.",
+  "author": "Balázs Orbán <info@balazsorban.com>",
+  "contributors": [
+    "Balázs Orbán <info@balazsorban.com>",
+    "Nico Domino <yo@ndo.dev>",
+    "Lluis Agusti <hi@llu.lu>",
+    "Thang Huu Vu <hi@thvu.dev>"
+  ],
+  "license": "MIT",
   "type": "module",
   "bin": {
     "auth": "index.js"
@@ -10,6 +22,8 @@
   "files": [
     "*.d.ts*",
     "*.js",
+    "!scripts",
+    "commands",
     "lib",
     "src"
   ],
@@ -17,12 +31,33 @@
     "authjs",
     "cli"
   ],
-  "author": "Balázs Orbán <info@balazsorban.com>",
-  "license": "MIT",
   "dependencies": {
-    "commander": "11.1.0"
+    "@inkeep/ai-api": "0.7.2",
+    "@inquirer/prompts": "5.1.0",
+    "clipboardy": "4.0.0",
+    "commander": "12.1.0",
+    "open": "10.1.0",
+    "ora": "8.0.1",
+    "prompts": "2.4.2",
+    "yoctocolors": "2.1.0"
   },
   "prettier": {
     "semi": false
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.9"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "bugs": {
+    "url": "https://github.com/nextauthjs/auth-cli/issues"
+  },
+  "main": "index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "generate-docs": "node ./scripts/generate-docs"
   }
 }