QUICK NAVIGATION - nself-org/cli GitHub Wiki

nself Quick Navigation

Find what you need in seconds.

I want to...

Get Started

Task Go to
Install nself Installation Guide
Get running in 5 minutes Quick Start
See a full demo Demo Setup
Understand what nself is Architecture Overview
Read FAQs FAQ

Work with Databases

Task Go to
Design a database schema Database Workflow
Run migrations db command
Seed test data db seed
Generate mock data db mock
Create backups Backup Guide
Generate TypeScript types db types
Connect from frontend API Reference

Deploy to Production

Task Go to
Deploy to a server Deployment Guide
Set up environments Environment Management
Configure SSL SSL Setup
Manage secrets Secrets Management
Zero-downtime deployment SSH Deployment
Deploy to Kubernetes K8s Commands
Choose a cloud provider Cloud Providers

Configure & Customize

Task Go to
Configure environment variables Environment Variables
Add custom services Custom Services
Enable optional services Optional Services
Set up monitoring Monitoring Bundle
Configure startup options Start Command Options
Set up admin UI Admin UI
Multi-app setup Multi-App Setup

Add Features

Task Go to
Add authentication Built-in - OAuth Setup
Add payments (Stripe) Stripe Plugin
Add real-time features Real-Time Features
Add file storage Optional Services
Add search Optional Services
Add email service Optional Services
Add custom domains Custom Domains Tutorial

Build SaaS Features

Task Go to
Multi-tenancy Organization Management
Billing & subscriptions Billing & Usage
White-label branding Examples
Usage tracking Billing & Usage
Build a SaaS in 15 min SaaS Tutorial

Work with Plugins

Task Go to
List available plugins Plugin Overview
Install a plugin plugin install
Configure Stripe Stripe Integration
Configure GitHub GitHub Plugin
Create a custom plugin Plugin Development

Troubleshoot Issues

Task Go to
Fix common issues Troubleshooting Guide
Run diagnostics doctor command
Check service health health command
View logs logs command
Billing issues Billing Troubleshooting
White-label issues White-Label Troubleshooting

Learn by Example

Task Go to
See code examples Examples
Follow step-by-step tutorials Tutorials
Build a SaaS SaaS Tutorial
Build a marketplace Marketplace Tutorial
Set up agency platform Agency Tutorial
Database examples Feature Examples

Look Up Commands

Task Go to
View all commands Commands Overview
Printable cheat sheet Command Reference
Database commands db command
Deployment commands deploy command
Performance commands perf & bench
Plugin commands plugin command

Understand the System

Task Go to
System architecture Architecture
Project structure Project Structure
Build system Build Architecture
Available services Services Overview
Service templates Service Templates
API reference API Reference

Contribute & Extend

Task Go to
Contribute to nself Contributing Guide
Development setup Development
Create service templates Service Templates
Create plugins Plugin Development
Write documentation Contributing

Security & Compliance

Task Go to
Security best practices Security Guide
Security audit Security Audit
SSL/TLS setup SSL Setup
Manage secrets Secrets Management

By User Type

New Users

  1. Installation Guide
  2. Quick Start
  3. Database Workflow
  4. FAQ

Developers

  1. Database Workflow
  2. API Reference
  3. Custom Services
  4. Examples

DevOps Engineers

  1. Deployment Guide
  2. Environment Management
  3. Security Guide
  4. Monitoring

SaaS Builders

  1. SaaS Tutorial
  2. Organization Management
  3. Billing & Usage
  4. Stripe Integration

By Use Case

Building a Web App

Building a SaaS

Building a Marketplace

Building an API

Common Workflows

Local Development

# See: Quick Start Guide
nself init
nself build
nself start
nself db schema apply schema.dbml

Quick Start Guide

Database Development

# See: Database Workflow
nself db schema scaffold saas
# Edit schema.dbml
nself db schema apply schema.dbml
nself db types generate

Database Workflow

Production Deployment

# See: Deployment Guide
nself env create prod production
# Edit server.json
nself deploy prod
nself prod status

Deployment Guide

Plugin Installation

# See: Plugin Guide
nself plugin list
nself plugin install stripe
# Configure .env
nself build && nself restart
nself plugin stripe sync

Plugin Overview

Can't Find What You Need?

  1. Search the docs - Use your browser's search (Cmd/Ctrl + F)
  2. Check the FAQ - FAQ
  3. View all commands - Commands Overview
  4. Ask the community - GitHub Discussions
  5. Report an issue - GitHub Issues

Back to Documentation Home

ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.

GitHub · Issues · Discussions · nself.org · docs.nself.org

⚠️ **GitHub.com Fallback** ⚠️