@lukoweb/create-apitogo
v0.2.13
Published
Create APIToGo docs site with one command
Readme
Create APIToGo App
Create a new APIToGo app in seconds with @lukoweb/create-apitogo.
Interactive
npx @lukoweb/create-apitogo@latest
# or
yarn create @lukoweb/apitogo
# or
pnpm create @lukoweb/apitogo
# or
bunx @lukoweb/create-apitogoYou will be asked for the project name, TypeScript, and ESLint. After scaffold it auto-wires a
nearby openapi.yaml (parent/siblings/site) and markdown under docs/, doc/, documents/, or
documentation/. The default template (sample homepage, docs, OpenAPI, and plans) is used
unless you pass --no-include-examples.
Non-interactive
npx @lukoweb/create-apitogo@latest dev-portal --typescript --eslint| Flag | Effect |
| ------------------------------------------------------- | ----------------------------------------------------------- |
| --typescript / --ts | TypeScript project (default if you skip prompts in CI) |
| --javascript / --js | JavaScript project |
| --eslint | Add ESLint config |
| --no-eslint | Skip ESLint config |
| --include-examples | Default template (on by default) |
| --no-include-examples | Empty template (hero + features only, no sample plans/docs) |
| --skip-install | Do not run the package manager after scaffolding |
| --use-npm / --use-pnpm / --use-yarn / --use-bun | Force a package manager |
--with-examples is an alias for --include-examples.
npx @lukoweb/create-apitogo@latest dev-portal --javascript --no-eslint
npx @lukoweb/create-apitogo@latest dev-portal --typescript --eslint --no-include-examplesSee npx @lukoweb/create-apitogo --help for the full list (--example, --skip-install, …).
Why use Create APIToGo App?
@lukoweb/create-apitogo allows you to create a new APIToGo app within seconds. It includes a
number of benefits:
- Interactive Experience: Running
npx @lukoweb/create-apitogo@latest(with no arguments) launches an interactive experience that guides you through setting up a project. - Zero Dependencies: Initializing a project is as quick as one second. Create APIToGo App has zero dependencies.
- Offline Support: Create APIToGo App will automatically detect if you're offline and bootstrap your project using your local package cache.
- Support for Examples: Create APIToGo App can bootstrap your application using an example from
the examples collection (e.g.
npx @lukoweb/create-apitogo --example my-docs).
