Artisaan Logo
Docs
Installation

Installation

How to install Artisaan CLI and create your first project

Manual Installation

You can install the CLI globally on your machine to use across multiple repositories.

curl -fsSL https://artisaan.com.br/install.sh | bash

Create project

Run the init command to create a new project or configure an existing one.
This will create an .artisaan folder in your root.

artisaan init

Next Steps

After installation, you can start generating documentation from your source code. The artisaan CLI identifies your project and folders, but you can customize this by editing the config.json file within folder .artisaan

Configure your paths

Tell Artisaan where your controllers, routes, or models are located.

{ "language": "typescript", "project": "nextjs", "search_paths": [ "src", "app" ], "ignore_paths": [ "node_modules", "dist", ".next" ] }

Run the generator

Parse your codebase and build the documentations.

artisaan generate