Skip to content

absolutejs/create-absolutejs

Repository files navigation

create-absolutejs

A CLI tool to scaffold new AbsoluteJS projects quickly and effortlessly.

Usage

Scaffold a new project called <project-name>:

bun create absolutejs my-app

Alternatively, using npm, Yarn, or pnpm:

npm create absolutejs my-app
yarn create absolutejs my-app
pnpm create absolutejs my-app

By default, the CLI will interactively prompt you for any missing configuration values. You can also supply flags to skip those prompts:

  • To skip all optional prompts and use none for every optional configuration:
    bun create absolutejs my-app --skip
  • To skip one optional prompt without providing a real value, pass none to that flag:
    bun create absolutejs my-app --auth none --engine none

Options

Usage: create-absolute [project-name] [options]

Arguments

  • project-name
    Name of the application to create. If omitted, you'll be prompted to enter one.

Options

  • --help, -h
    Show this help message and exit.

  • --debug, -d
    Display a summary of the project configuration after creation.

  • --angular
    Include an Angular frontend.

  • --angular-dir <directory>
    Specify the directory for and use the Angular frontend.

  • --assets <directory>
    Directory name for your static assets.

  • --auth <plugin|none>
    Pre-configured auth plugin (currently only absolute-auth) or none.

  • --biome
    Use Biome for code quality and formatting.

  • --build <direrctory>
    Output directory for build artifacts.

  • --db <engine|none>
    Database engine (postgresql | mysql | sqlite | mongodb | redis | singlestore | cockroachdb | mssql) or none.

  • --db-dir <directory>
    Directory name for your database files.

  • --db-host <provider|none>
    Database host provider (neon | planetscale | supabase | turso | vercel | upstash | atlas) or none.

  • --directory <default|custom>
    Directory-naming strategy: default or custom.

  • --eslint+prettier
    Use ESLint + Prettier for code quality and formatting.

  • --git
    Initialize a Git repository.

  • --html
    Include a plain HTML frontend.

  • --html-dir <directory>
    Specify the directory for and use the HTML frontend.

  • --html-scripts
    Enable HTML scripting with TypeScript.

  • --htmx
    Include an HTMX frontend.

  • --htmx-dir <directory>
    Specify the directory for and use the HTMX frontend.

  • --install
    Use the same package manager to install dependencies.

  • --lts
    Use LTS versions of required packages.

  • --orm <drizzle|prisma|none>
    ORM to configure: drizzle | prisma | none.

  • --plugin <plugin>
    Elysia plugin(s) to include (repeatable); none skips plugin setup.

  • --react
    Include a React frontend.

  • --react-dir <directory>
    Specify the directory for and use the React frontend.

  • --skip
    Skip non-required prompts; uses none for all optional configs.

  • --svelte
    Include a Svelte frontend.

  • --svelte-dir <directory>
    Specify the directory for and use the Svelte frontend.

  • --tailwind
    Include Tailwind CSS setup.

  • --tailwind-input <file>
    Path to your Tailwind CSS entry file.

  • --tailwind-output <file>
    Path for the generated Tailwind CSS bundle.

  • --vue
    Include a Vue frontend.

  • --vue-dir <directory>
    Specify the directory for and use the Vue frontend.

Directory Configuration

Choose between the default layout (pre-configured folder names) or custom, which prompts you to specify each directory name yourself:

bun create absolutejs my-app --directory custom

Debug & LTS Flags

  • --debug, -d
    After scaffolding, prints a detailed summary of your configuration (language, frontends, directories, etc.).
  • --lts
    Instructs the CLI to fetch and pin the latest published versions of your dependencies instead of its default pinned versions.

Getting Started

Once the scaffold completes, you’re ready to go:

cd my-app
# (If you skipped automated install)
bun install
# Then start the dev server
bun run dev

If you downloaded this repository to test or make changes you can use bun run test to start the created dev server without having to change directories back and forth.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the CLI.

License

Licensed under CC BY-NC 4.0.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published