CLI Tool
Command-Line Interface for QuickCode
Manage your projects, modules, and microservices generation directly from your terminal.

Installation

macOS (Homebrew)

1
Install QuickCode CLI
brew tap QuickCodeNet/quickcode-cli brew install quickcode-cli
2
Verify installation
Confirm QuickCode CLI is installed correctly
quickcode --version
3
Update to latest version
Run this when a new release is available
brew update brew upgrade quickcode-cli

Windows (Scoop)

1
Install QuickCode CLI
scoop bucket add quickcode-cli https://github.com/uzeyirapaydin/scoop-bucket scoop install quickcode-cli
2
Verify installation
Confirm QuickCode CLI is installed correctly
quickcode --version
3
Update to latest version
Run this when a new release is available
scoop update scoop update quickcode-cli

Quick Start Guide

Get started with QuickCode CLI in minutes

0

Project Name

All commands below will use this name
1

Check if project exists

quickcode demo check
2

Create a new project

quickcode demo create --email [email protected]
The email is automatically saved to local config after creation.
3

Store project secret code

quickcode demo config --set secret_code=YOUR_SECRET_CODE
Check your email for the secret code.
4

Add a module

quickcode demo modules add --module-name MyModule
Or with all parameters explicitly:
quickcode demo modules add --module-name MyModule \ --template-key UserManager \ --db-type mssql \ --pattern Service
Valid Parameter Values:
• db-type: mssql, mysql, postgresql
• pattern: Service, CqrsAndMediator
5

Download and edit DBML files

quickcode demo get-dbmls
Downloads project modules, README.md, and templates to your local folder.
6

Upload DBML changes

quickcode demo update-dbmls
7

Generate microservices

quickcode demo generate
By default, watches the generation progress in real-time.
quickcode demo generate --watch false
8

Clone the generated project

quickcode demo pull
Clones or pulls your project from GitHub.

Command Reference

Command Description Example
project create Create project / trigger secret e-mail quickcode project create --name demo
project check Check if project exists quickcode project check --name demo
project forgot-secret Send secret reminder email quickcode demo forgot-secret
project verify-secret Validate email + secret combination quickcode demo verify-secret
project get-dbmls Download project modules and templates quickcode demo get-dbmls
project update-dbmls Upload DBML files to API quickcode demo update-dbmls
module available List available module templates quickcode module available
module list List modules in project quickcode demo modules
module add Add a new module to project quickcode demo modules add
module remove Remove module from project quickcode demo modules remove
generate [--watch] Trigger generation and watch progress quickcode demo generate
<project> pull Clone or pull project from GitHub quickcode demo pull
<project> push Push changes to GitHub quickcode demo push

Security Features

Encrypted Secrets

Secret codes are automatically encrypted using AES-256 encryption before being stored in the configuration file.

Encryption Key

The encryption key is stored at ~/.quickcode/.key with restricted file permissions (600 on Unix/macOS).

Automatic Migration

Existing plain-text secrets are automatically encrypted on first load for backward compatibility.

Protected Display

Secret codes are never displayed in plain text; they appear as ******** when viewing config.

Ready to Get Started?

Download the latest version from GitHub or install via package manager

Download from GitHub View Documentation
Üzeyir Apaydın

© QuickCode.Net 2019 - 2025. All rights reserved.