ToolingCLI

Overview

The Arkos.js CLI is a built-in command-line tool available inside any Arkos.js project. It handles your development server, production builds, and all code generation — giving you a consistent, convention-driven workflow without repetitive boilerplate.

Unlike create-arkos, which bootstraps new projects, this CLI lives inside your project and is used day-to-day.

arkos [command] [options]

Command Reference

Server Commands

CommandDescription
arkos devStart development server with hot-reload
arkos buildCompile an optimized production build
arkos startRun the production build

Code Generation Commands

CommandAliasDescriptionSince
arkos generate controllerarkos g cController classv1.3
arkos generate servicearkos g sService classv1.3
arkos generate routerarkos g rRouter with RouteHookv1.3
arkos generate interceptorsarkos g iInterceptors filev1.3
arkos generate hooksarkos g hService hooks filev1.3
arkos generate schemaarkos g scBase Zod schemav1.5
arkos generate create-schemaarkos g csCreate Zod schemav1.4
arkos generate update-schemaarkos g usUpdate Zod schemav1.4
arkos generate query-schemaarkos g qsQuery Zod schemav1.5
arkos generate dtoarkos g dBase class-validator DTOv1.5
arkos generate create-dtoarkos g cdCreate DTOv1.4
arkos generate update-dtoarkos g udUpdate DTOv1.4
arkos generate query-dtoarkos g qdQuery DTOv1.5
arkos generate query-optionsarkos g qPrisma query optionsv1.3
arkos generate modelarkos g mPrisma model filev1.5
arkos generate policyarkos g pArkosPolicy filev1.6
arkos generate auth-configsarkos g aAuth config file (deprecated)v1.3
arkos generate login-schemaarkos g lsLogin Zod schemav1.6
arkos generate signup-schemaarkos g ssSignup Zod schemav1.6
arkos generate update-me-schemaarkos g umsUpdate-me Zod schemav1.6
arkos generate update-password-schemaarkos g upsUpdate-password Zod schemav1.6
arkos generate login-dtoarkos g ldLogin DTOv1.6
arkos generate signup-dtoarkos g sdSignup DTOv1.6
arkos generate update-me-dtoarkos g umdUpdate-me DTOv1.6
arkos generate update-password-dtoarkos g updUpdate-password DTOv1.6
arkos generate componentsarkos g coGenerate multiple components at oncev1.5

TypeScript Commands

CommandAliasDescriptionSince
arkos prisma generatearkos p gGenerate Prisma client and sync Arkos typesv1.4

Common Flags

All generate commands share these flags:

FlagDescription
-m, --module <name>Module name (recommended)
--model <name>Module name — deprecated alias, use --module
--modules <names>Comma-separated module names for multi-module generation
-p, --path <path>Custom output path (default: src/modules)
-o, --overwriteOverwrite existing files

Project Structure

Generated files follow a consistent layout:

src/modules/
└── post/
    ├── post.controller.ts
    ├── post.service.ts
    ├── post.router.ts
    ├── post.interceptors.ts
    ├── post.hooks.ts
    ├── post.policy.ts
    ├── post.query.ts
    ├── schemas/
    │   ├── post.schema.ts
    │   ├── create-post.schema.ts
    │   ├── update-post.schema.ts
    │   └── query-post.schema.ts
    └── dtos/
        ├── post.dto.ts
        ├── create-post.dto.ts
        ├── update-post.dto.ts
        └── query-post.dto.ts

Naming Conventions

StyleUsed forExample
kebab-caseFiles, routesuser-profile.controller.ts
camelCaseVariables, instancesuserProfileController
PascalCaseClasses, typesUserProfileController

The CLI detects whether your project uses TypeScript or JavaScript and generates files with the correct extension and type annotations automatically.

Create Arkos CLI

Previous Page

Development

Next Page

On this page

Command ReferenceServer CommandsCode Generation CommandsTypeScript CommandsCommon FlagsProject StructureNaming ConventionsRelated Guides