πŸš€ DAY 1 OF LAUNCH WEEK: Reachability for Ruby Now in Beta.Learn more β†’
Socket
Book a DemoInstallSign in
Socket

flow-state-dev

Package Overview
Dependencies
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

flow-state-dev

The fastest way to start a modern web project that both you and Claude Code will love

latest
Source
npmnpm
Version
2.1.3
Version published
Maintainers
1
Created
Source

Flow State Dev πŸš€

npm version License: MIT Security: Built-in

The fastest way to start a modern web project that both you and Claude Code will love.

What is Flow State Dev?

Flow State Dev (FSD) is an intelligent project scaffolding tool that creates production-ready web applications with built-in security, comprehensive documentation, and AI-optimized workflows. It's designed to eliminate the friction between human developers and AI coding assistants while ensuring your projects start with security best practices from day one.

✨ Key Features

  • πŸ”’ Security-First - Automatic repository detection, secret protection, pre-commit hooks
  • πŸ€– AI-Optimized - Claude Code ready with comprehensive context files
  • πŸ“š Documentation Rich - 21+ templates included from day one
  • πŸ”§ Modular Architecture - Extensible plugin-based onboarding system
  • 🏷️ GitHub Integration - 66 labels for comprehensive project management
  • ⚑ Slash Commands - Powerful project management commands for sprints, epics, and issues
  • πŸš€ Modern Stack - Vue 3, React, SvelteKit with Vuetify, Tailwind CSS, Better Auth

πŸŽ‰ What's New

v0.4.0 - SvelteKit + Better Auth Support 🎯

  • πŸš€ SvelteKit Framework - Full support for SvelteKit 2.0 with TypeScript
  • πŸ” Better Auth Integration - Modern authentication system with email/OAuth support
  • πŸ“¦ New Stack Presets - SvelteKit Full Stack, Frontend, and Minimal configurations
  • ⚑ File-based Routing - SvelteKit's powerful routing system out of the box
  • πŸ§ͺ Testing Ready - Vitest for unit tests, Playwright for E2E tests
  • 🎨 Works with Tailwind - Full compatibility with Tailwind CSS for styling

v2.1 - Minimal Setup for Beginners πŸ“¦

  • πŸ“¦ Minimal Setup Option - Start without a framework, choose later
  • πŸ“š Framework Selection Guide - Comprehensive comparison of Vue, React, Svelte
  • 🎯 No Decision Paralysis - Perfect for beginners or exploration
  • ⚑ Easy Upgrade Path - Add framework later with fsd upgrade --add-framework
  • πŸ”§ Basic Tooling - Vite, ESLint, Prettier included from the start

v2.0 - Modular Slash Command Architecture πŸš€

  • πŸ—οΈ Modular Architecture - All 67+ commands refactored into individual modules
  • ⚑ Enhanced Performance - Command discovery <25ms, execution <100ms
  • πŸ”Œ Plugin Support - Extensible system for custom commands
  • πŸ“ Category Organization - Commands organized into 10 logical categories
  • 🎯 Dynamic Discovery - Commands loaded on-demand for better performance
  • 🧩 Consistent Interface - All commands extend BaseSlashCommand class
  • πŸ“Š 100% Migration - Complete transition from monolithic to modular system

Perfect for AI-assisted development - Commands demonstrate extended thinking processes and create structured documentation. From quick daily tasks to complex architectural decisions!

v0.11.0 - Smart Environment Detection

  • πŸ” Auto-Detection - Automatically detects development environment and tools
  • πŸ› οΈ Tool Discovery - Finds installed package managers, databases, CLI tools
  • πŸ“Š Project Analysis - Detects frameworks, testing tools, project patterns
  • 🎯 Smart Defaults - Pre-fills memory setup with detected values
  • ⚑ Faster Setup - Reduces manual input with intelligent suggestions
  • πŸ”’ Privacy First - Opt-in detection with transparent results

v0.10.0 - Enhanced Memory System

  • 🧠 Enhanced Memory Setup - Comprehensive section-by-section configuration
  • πŸ“„ Template System - Pre-built personas (Vue Developer, Full Stack, AI Engineer)
  • 🧩 Section Library - Modular, reusable configuration blocks
  • πŸ”„ Project Integration - Memory setup during fsd init with --memory flag
  • πŸ’Ύ Progress Saving - Resume interrupted setup sessions
  • ✨ Variable Substitution - Dynamic templates with smart defaults

v0.12.0 - Project Retrofit System πŸ”„

  • πŸ”„ Project Retrofit System - Safely add Flow State Dev features to existing projects
  • πŸ“‹ fsd upgrade - Interactive upgrade system with backup and rollback capability
  • πŸ” Project Analysis - Intelligent detection of missing features and upgrade opportunities
  • πŸ’Ύ Automatic Backups - Complete safety with timestamped backups before any changes
  • πŸ‘€ Change Preview - See exactly what will be modified before applying changes
  • πŸ“š Documentation Module - Add 21+ comprehensive templates to any existing project
  • πŸ›‘οΈ Enhanced Safety - Advanced conflict detection and file preservation

Perfect for existing projects - Finally, a safe way to add Flow State Dev features to projects you've already started! No more starting over.

v0.11.1 - Analysis & Planning Slash Commands ✨

  • πŸ” Analysis Commands - Transform ideas into trackable GitHub issues
  • πŸ“‹ /breakdown - Analyze scope and create comprehensive issue breakdowns
  • 🎯 /epic:breakdown - Break large epics into user stories and technical tasks
  • ⚑ /feature:plan - Complete feature planning from concept to implementation
  • πŸ”¬ /analyze:scope - Detailed scope analysis with dependency mapping
  • πŸš€ Auto Issue Creation - One command creates multiple properly structured GitHub issues

Perfect for the "looks good, make GitHub issues" workflow - These commands take your high-level ideas and automatically break them down into detailed, trackable GitHub issues with proper labels, milestones, and templates. No more manual analysis and issue creation!

v0.9.0 - Slash Commands for Project Management

  • ⚑ Slash Commands - Powerful project management with fsd slash "/command"
  • 🎯 Sprint Management - Plan, review, and close sprints with capacity tracking
  • πŸ“‹ Epic Management - Create and track epics with automated templates
  • πŸ”„ Issue Operations - Bulk operations and dependency analysis
  • πŸ“Š Progress Reporting - Generate weekly/monthly reports with metrics
  • πŸ”— GitHub Integration - Deep integration with GitHub CLI and API

v0.8.0 - Pinia Store Generator

  • πŸͺ Store Generator - fsd store <name> generates complete Pinia stores
  • πŸ”„ Multiple Templates - Default, Supabase, Auth, and Minimal templates
  • πŸ”Œ Supabase Integration - Real-time subscriptions and RLS support
  • 🎯 Smart Defaults - Includes loading states, error handling, and CRUD operations
  • πŸ“š Comprehensive Docs - Complete guide with examples and best practices

v0.7.0 - Local Supabase Development

  • 🐳 Local Development Setup - Automated Docker & Supabase CLI installation
  • πŸš€ Supabase Commands - fsd supabase start/stop/reset/migrate/seed
  • 🏠 Offline Development - Work without internet, full database control
  • πŸ”§ Enhanced Doctor - Checks for local development prerequisites
  • πŸ“š Local Dev Guide - Comprehensive documentation for local workflows

v0.6.0 - Security & Modular Architecture

  • πŸ”’ Automatic Security Detection - Detects public/private repositories and adapts configuration
  • πŸ›‘οΈ Built-in Secret Protection - Prevents accidental credential exposure with smart validation
  • πŸ”§ Modular Onboarding System - Extensible, plugin-based project initialization
  • πŸ” Security Scanner - Built-in tools to scan for exposed secrets
  • πŸ“ Security Templates - Enhanced .gitignore, pre-commit hooks, and security docs

v0.5.0 - Comprehensive Documentation

  • πŸ“š Complete docs/ folder with context, guides, API docs, and architecture decisions
  • πŸ€– AI-specific .claude/ folder with personality, code style, and avoid patterns
  • πŸ“ 21 pre-filled documentation templates following best practices
  • πŸ—οΈ Architecture Decision Records (ADR) system built-in

Quick Start (2 minutes)

npx flow-state-dev init

No installation needed! Just run and create your project

Option 2: Install globally for frequent use

npm install -g flow-state-dev
fsd init

The -g flag installs globally so you can use fsd from anywhere

Quick Start Examples

# Create a SvelteKit project with authentication
fsd init my-app --preset sveltekit-full-stack

# Create a React project with Tailwind
fsd init my-app --preset react-frontend  

# Create a Vue project with Vuetify
fsd init my-app --preset vue-full-stack

# Create a minimal project (no framework)
fsd init my-app --preset minimal

# Use specific modules
fsd init my-app --modules sveltekit,better-auth,tailwind

Linux Users: If you get an EACCES permission error, don't use sudo! See our Linux Troubleshooting Guide for safe solutions, or just use npx (Option 1) to avoid installation issues entirely.

The intelligent setup will guide you through:

  • πŸ” Security Analysis - Automatic detection of repository visibility
  • 🎨 Framework Selection - Choose Vue, React, or start minimal (no framework)
  • πŸ“¦ NEW: Minimal Setup - Start without a framework, add one later when ready
  • πŸ”’ Secure Configuration - Context-aware Supabase credential setup
  • βœ… GitHub Integration - Repository connection and label management
  • πŸ›‘οΈ Security Templates - Auto-generated .gitignore and security docs

Example: Security-Aware Setup

$ fsd init my-app

πŸ” Repository Analysis
⚠️  PUBLIC repository detected: github.com/user/my-app

🚨 SECURITY WARNING: This is a PUBLIC repository!
   Anyone can see your code and any secrets you commit.

πŸ”’ Using placeholder values for security
πŸ“„ Created .env.example with safe templates
πŸ“š Created security documentation

3. Start developing

cd your-project-name
npm install
npm run dev

That's it! Your project is configured and ready to run.

Where Do Files Go?

By default, Flow State Dev creates a new subfolder for your project. You'll be asked where to put files:

  • Subfolder (default): Creates ./my-app/ in current directory
  • Current directory: Adds files to where you are now

Use flags to skip the prompt:

fsd init my-app --subfolder  # Always create subfolder
fsd init my-app --here       # Use current directory

You now have a fully configured project with:

  • 🎨 Your choice of framework and UI library
  • πŸ”’ Security-first configuration based on repository visibility
  • πŸ“š Comprehensive documentation structure (21+ templates)
  • πŸ€– Claude-ready with AI-optimized context files
  • ⚑ Supabase integration with secure credential handling
  • πŸ›‘οΈ Pre-commit hooks for secret detection
  • βœ… GitHub-ready with enhanced .gitignore
  • πŸ” Built-in security scanning tools

What's Included?

Available Frameworks

βœ… Minimal Setup (NEW - Available Now)

  • No Framework - Start with basic HTML/CSS/JS
  • Vite for fast builds and hot module replacement
  • ESLint + Prettier for code quality
  • Framework Guide - Comprehensive guide to help you choose
  • Easy Upgrade Path - Add a framework when you're ready with fsd upgrade --add-framework
  • Perfect for beginners or when you want to explore options first

βœ… Vue 3 + Vuetify (Available Now)

  • Vue 3 with Composition API
  • Vuetify 3 for beautiful Material Design components
  • Supabase for backend (auth, database, storage)
  • Vue Router for navigation
  • Pinia for state management
  • Vite for lightning-fast builds

βœ… React (Available Now)

  • React 18 with TypeScript support
  • React Router for navigation
  • Tailwind CSS for styling
  • Vite for fast development
  • Vitest for testing
  • ESLint + Prettier configured

βœ… SvelteKit (Available Now)

  • SvelteKit 2.0 with TypeScript
  • File-based routing built-in
  • Better Auth for authentication
  • Tailwind CSS compatible
  • Vitest + Playwright for testing
  • Server-side rendering support

πŸ”œ Coming Soon

  • Next.js - React with SSR/SSG
  • Nuxt 3 - Vue with SSR/SSG
  • Remix - Full-stack React framework

Developer Tools

  • CLAUDE.md file pre-configured with project info
  • .claude/settings.json with pre-approved commands for Claude Code
  • Standard GitHub labels for consistent issue tracking
  • Environment variable template
  • Clear folder structure

Commands

Using npx (no installation needed)

npx flow-state-dev init           # Create a new project
npx flow-state-dev doctor         # Run diagnostics
npx flow-state-dev memory init    # Setup Claude memory
npx flow-state-dev labels         # Setup GitHub labels
npx flow-state-dev security scan  # Scan for exposed secrets
npx flow-state-dev store <name>   # Generate a Pinia store
npx flow-state-dev upgrade        # Add Flow State Dev features to existing projects

Using global installation

# Project Creation
fsd init                # Create a new project (interactive)
fsd init --no-interactive  # Skip interactive setup
fsd init --here         # Use current directory
fsd init --subfolder    # Create in subfolder (default)

# Local Development Setup
fsd setup-local         # Install Docker & Supabase CLI
fsd supabase init       # Initialize Supabase in project
fsd supabase start      # Start local Supabase
fsd supabase stop       # Stop local Supabase
fsd supabase reset      # Reset database
fsd supabase migrate    # Run migrations
fsd supabase seed       # Seed database
fsd supabase status     # Check status

# Security Tools
fsd security scan       # Scan project for exposed secrets
fsd security check      # Check repository security status
fsd security setup      # Configure security tools

# GitHub Integration
fsd labels              # Interactive label setup (choose collection)
fsd labels create       # Create labels with options
fsd labels list         # Show available label collections
fsd labels export       # Export current repo labels

# Development Tools
fsd doctor              # Run diagnostics on your project
fsd doctor --fix        # Auto-fix common issues

# Code Generation
fsd store <name>        # Generate a new Pinia store
fsd store user --supabase  # Generate Supabase-connected store
fsd store auth --auth   # Generate authentication store
fsd store ui --minimal  # Generate minimal store

# Claude Memory Management
fsd memory init         # Create your Claude Code memory file
fsd memory show         # Display your memory file
fsd memory edit         # Edit memory file in your editor
fsd memory validate     # Validate memory structure
fsd memory fix          # Auto-fix memory issues

# Analysis & Planning Commands  
fsd slash "/breakdown --scope 'feature description'"     # Analyze and create issues
fsd slash "/epic:breakdown --epic 'epic description'"    # Break epic into stories  
fsd slash "/feature:plan --feature 'feature' --complexity medium"  # Feature planning
fsd slash "/analyze:scope --requirements 'requirements'" # Detailed scope analysis

# Examples with issue creation
fsd slash "/breakdown --scope 'user auth system' --create-issues --milestone 'v2.0'"
fsd slash "/epic:breakdown --epic 'dashboard redesign' --create-issues --assignee johndoe"

# Quick Action Commands
fsd slash "/build"              # Run project build command
fsd slash "/test --coverage"    # Run tests with coverage report
fsd slash "/lint --fix"         # Run linter with auto-fix
fsd slash "/typecheck"          # Run TypeScript type checking
fsd slash "/status"             # Enhanced git status with categorization
fsd slash "/commit"             # Interactive conventional commit
fsd slash "/push"               # Push to current branch

# Extended Thinking Commands (Deep Analysis)
fsd slash "/plan --topic 'feature architecture' --create-adr"    # Comprehensive planning with ADR
fsd slash "/investigate --question 'performance bottlenecks'"     # Multi-source research
fsd slash "/decide --decision 'database choice' --alternatives 3" # Decision analysis with ADR
fsd slash "/estimate --work 'API refactoring' --method story-points" # Complex estimation
fsd slash "/debug:strategy --problem 'memory leak' --urgency high"   # Systematic debugging
fsd slash "/research --topic 'microservices patterns'"           # Deep research analysis

# Project Upgrade & Retrofit System
fsd upgrade            # Safely add Flow State Dev features to existing projects
fsd upgrade --preview  # Preview changes without applying them
fsd upgrade --features "Documentation,Security" # Apply specific features
fsd upgrade --list-backups    # Show available backups
fsd upgrade --rollback backup-2025-01-23-14-30-15  # Rollback to backup

# Help
fsd help               # Show all commands

Slash Commands System

Flow State Dev includes a comprehensive slash command system with 67+ commands across 10 categories. All commands use a modular architecture where each command is a separate module, enabling better performance, maintainability, and extensibility.

Command Categories

CategoryCommandsDescription
Quick Action14Daily workflow automation (build, test, git operations)
Analysis & Planning10Project analysis and issue creation
Workflow Automation8CI/CD and deployment management
Sprint Management6Agile sprint planning and tracking
Estimation6Story point estimation and capacity planning
Extended Thinking5Deep analysis with AI-style thinking
Project Management5Issues, milestones, and labels
Issue Operations5Bulk operations and dependency analysis
Analysis5Code metrics and quality analysis
Utility3Help, sync, and cleanup commands

Quick Examples

# Quick daily commands with aliases
fsd slash "/b"              # Build (alias for /build)
fsd slash "/t"              # Test (alias for /test)
fsd slash "/l --fix"        # Lint with fix (alias for /lint)

# Sprint management
fsd slash "/sprint:plan --weeks 2 --capacity 40"
fsd slash "/sprint:review --milestone 'Sprint 5'"

# Planning and analysis
fsd slash "/breakdown 'User authentication system' --create-issues"
fsd slash "/epic:breakdown 'Dashboard redesign' --milestone v2.0"

# Extended thinking commands
fsd slash "/plan 'API architecture' --create-adr"
fsd slash "/decide 'Database: PostgreSQL vs MongoDB'"
fsd slash "/alternatives 'State management for React'"

Command Features

  • Modular Architecture: Each command is a separate module for easy extensibility
  • Interactive Prompts: All commands support interactive mode when arguments are omitted
  • GitHub Integration: Deep integration with GitHub API for issue/PR management
  • Smart Detection: Automatically detects project configuration and scripts
  • Extended Thinking: Some commands show AI-style thinking process
  • Report Generation: Many commands can generate markdown reports
  • ADR Creation: Planning commands can create Architecture Decision Records
  • Plugin Support: Add custom commands by creating new command modules
  • Performance: Command discovery <25ms, execution <100ms

For a complete list of commands, run:

fsd slash "/help"

Project Structure

my-app/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/     # Reusable Vue components
β”‚   β”œβ”€β”€ composables/    # Composition API utilities
β”‚   β”œβ”€β”€ router/         # Route definitions
β”‚   β”œβ”€β”€ stores/         # Pinia stores
β”‚   β”œβ”€β”€ services/       # API services (Supabase)
β”‚   β”œβ”€β”€ views/          # Page components
β”‚   β”œβ”€β”€ App.vue         # Root component
β”‚   └── main.js         # App entry point
β”œβ”€β”€ docs/               # πŸ“š Comprehensive documentation
β”‚   β”œβ”€β”€ context/        # Project context for AI & humans
β”‚   β”œβ”€β”€ guides/         # How-to guides
β”‚   β”œβ”€β”€ api/            # API documentation
β”‚   β”œβ”€β”€ architecture/   # Technical decisions
β”‚   └── SECURITY.md     # πŸ”’ Security best practices
β”œβ”€β”€ .claude/            # πŸ€– AI-specific context files
β”‚   β”œβ”€β”€ personality.md  # How AI should interact
β”‚   β”œβ”€β”€ code-style.md   # Coding preferences
β”‚   └── avoid.md        # Anti-patterns to avoid
β”œβ”€β”€ .security/          # πŸ›‘οΈ Security configuration
β”‚   └── secret-patterns.json  # Secret detection patterns
β”œβ”€β”€ .githooks/          # πŸͺ Git hooks for security
β”‚   └── pre-commit      # Automatic secret scanning
β”œβ”€β”€ public/             # Static assets
β”œβ”€β”€ .env.example        # Environment template (safe to commit)
β”œβ”€β”€ .gitignore          # Enhanced with 60+ security patterns
β”œβ”€β”€ CLAUDE.md          # AI assistant instructions
└── README.md          # Your project docs

πŸ”’ Security-First Approach

Flow State Dev automatically adapts to your repository's security context:

Public Repository Mode

  • Uses placeholder values for all credentials
  • Creates .env.example with safe templates
  • Generates comprehensive security warnings
  • Provides detailed setup instructions

Private Repository Mode

  • Allows real credential configuration
  • Creates .env files for immediate use
  • Enables team collaboration features
  • Supports production deployments

Built-in Security Features

  • Secret Detection: 9 built-in patterns for common secrets
  • Pre-commit Hooks: Automatic scanning before commits
  • Enhanced .gitignore: 60+ patterns for sensitive files
  • Security Scanner: fsd security scan command
  • Repository Analysis: Automatic visibility detection

πŸ”’ Security Tools

Scan for Exposed Secrets

fsd security scan         # Scan entire project
fsd security scan --verbose  # Show detailed results

Detects:

  • Supabase service keys and credentials
  • Database URLs with passwords
  • JWT secrets and API keys
  • Private keys and certificates
  • AWS/OpenAI/Stripe credentials

Check Repository Security

fsd security check

Shows:

  • Repository visibility (public/private)
  • Security recommendations
  • Configuration suggestions

Setup Security Tools

fsd security setup

Creates:

  • Enhanced .gitignore with 60+ patterns
  • Pre-commit hooks for secret detection
  • Security documentation
  • Secret detection patterns

Setting Up GitHub Labels

After creating your GitHub repository:

cd my-awesome-app
fsd labels

This will create a comprehensive set of labels for better issue tracking:

  • Epic/Feature/Task/Bug: Issue type hierarchy
  • Status: planning, in-progress, review, done, blocked
  • Priority: critical, high, medium, low
  • Effort: tiny, small, medium, large, xlarge
  • And 50+ more: Components, tech stack, workflow states

See docs/LABELS.md for complete label usage guidelines.

Managing Your Claude Code Memory

Flow State Dev includes tools to help you create and manage your Claude Code user memory file:

Quick Setup (< 1 minute)

fsd memory init

This creates a personalized memory file at ~/.claude/CLAUDE.md with:

  • Your name and role
  • Detected OS and environment
  • Tech stack preferences
  • Work style (prototyping, production, learning, etc.)

Other Memory Commands

fsd memory show      # Display your current memory file
fsd memory edit      # Open memory file in your editor
fsd memory import    # Import from existing memory files
fsd memory validate  # Validate memory file structure
fsd memory fix       # Auto-fix common issues

Why Use Memory Files?

Memory files help Claude Code understand your preferences across all projects:

  • Consistent coding style
  • Preferred tools and libraries
  • Work approach and communication style

Working with Claude Code

Flow State Dev creates multiple files to optimize AI assistance:

CLAUDE.md - Project Instructions

  • Tech stack and versions
  • Project structure and conventions
  • Common patterns and utilities
  • Development commands
  • Troubleshooting guides

.claude/ Folder - AI Context

  • personality.md: How Claude should communicate
  • code-style.md: Preferred coding patterns
  • avoid.md: Anti-patterns to prevent
  • settings.json: Pre-approved commands for smoother workflow

Security Integration

Claude Code automatically understands:

  • Repository security context
  • Safe credential handling
  • Security best practices
  • Project-specific security requirements

Just open your project in Claude Code and start building securely!

Using npx (No Installation Needed!)

Don't want to install globally? Use npx to run Flow State Dev directly:

# Create a new project
npx flow-state-dev init my-app

# Run diagnostics
npx flow-state-dev doctor

# Set up GitHub labels
npx flow-state-dev labels

# Create memory file
npx flow-state-dev memory init

Benefits of using npx:

  • βœ… No global installation required
  • βœ… Always uses the latest version
  • βœ… No PATH configuration needed
  • βœ… Perfect for trying out Flow State Dev

Requirements

  • Node.js 18+
  • npm or yarn
  • Git
  • A Supabase account (free tier works great)

πŸ“– Documentation

Why Flow State Dev?

πŸ”’ Security First

  • Automatic Repository Detection: Knows if your repo is public or private
  • Context-Aware Configuration: Different behavior for different security contexts
  • Built-in Secret Protection: Prevents accidental credential exposure
  • Pre-commit Security Hooks: Catches secrets before they're committed

πŸš€ Developer Experience

  • Zero Configuration: Start coding immediately
  • Best Practices Built-in: Proper structure from day one
  • AI-Friendly: Claude Code understands your project instantly
  • Comprehensive Documentation: 21+ templates included
  • Local Development: Full offline Supabase development support

πŸ”§ Extensibility

  • Modular Architecture: Plugin-based onboarding system
  • Multiple Frameworks: Vue now, React/Svelte coming soon
  • Custom Steps: Add your own onboarding modules
  • Future-Ready: Easy to extend and customize

🏠 Local Development Power

  • Automated Setup: One command to install all tools
  • Offline First: Work without internet connection
  • Full Control: Direct database access and modifications
  • Fast Iteration: No API rate limits or network latency

Troubleshooting

Quick Diagnostic

If Flow State Dev isn't working, run our diagnostic tool:

curl -s https://raw.githubusercontent.com/jezweb/flow-state-dev/main/debug/diagnose.sh | bash

This will analyze your system and provide specific fix recommendations.

Installation Issues

Recommended: Use npx to avoid installation issues entirely:

npx flow-state-dev init

If you prefer global installation and encounter permission errors:

# On macOS/Linux, you might need sudo
sudo npm install -g flow-state-dev

# Or configure npm to use a different directory
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

Command Not Found

If fsd command is not found after global installation:

Quick Solution: Use npx instead

npx flow-state-dev init

Or fix your PATH:

  • Check npm global bin directory: npm bin -g
  • Make sure it's in your PATH
  • Try running with full path: $(npm bin -g)/fsd

Linux Users: See our comprehensive Linux Troubleshooting Guide for detailed PATH configuration instructions.

GitHub CLI Not Installed

If you see "GitHub CLI not installed" warnings:

Project Name Issues

Flow State Dev auto-fixes project names:

  • Converts "My App" β†’ "my-app"
  • Removes special characters
  • Only allows letters, numbers, and hyphens

Folder Confusion

  • fsd init my-project creates ./my-project/ subfolder
  • If you're already in my-project/ folder and it's empty, Flow State Dev will offer to use it
  • Files always go where you expect them!

Advanced Features

Modular Onboarding System

Flow State Dev uses a plugin-based architecture for project initialization:

  • Extensible step-based workflow
  • Custom onboarding modules
  • Context-aware execution
  • Dependency resolution

See docs/MODULAR_ONBOARDING.md for creating custom steps.

Enhanced GitHub Project Management

Comprehensive label system with:

  • Issue hierarchy (Epic β†’ Feature β†’ Task)
  • Sprint and release tracking
  • Effort and impact estimation
  • Smart label combinations

See docs/GITHUB_PROJECT_MANAGEMENT.md for workflows.

Security Documentation

Flow State Dev includes comprehensive security documentation to help you build secure applications:

Documentation

Command Guides

Feature Guides

Getting Help

License

MIT Β© Jezweb

Security Philosophy

Flow State Dev believes that security should be built-in, not bolted-on. Every project starts with:

  • πŸ” Automatic Detection - Knows your security context before asking for credentials
  • πŸ›‘οΈ Safe Defaults - Placeholder values in public repos, real values only when safe
  • 🚨 Active Protection - Pre-commit hooks and scanning tools prevent accidents
  • πŸ“š Education - Clear warnings and documentation guide best practices

We make it nearly impossible to accidentally expose secrets while maintaining excellent developer experience.

Made with ❀️ in Newcastle, Australia by Jez

Keywords

vue

FAQs

Package last updated on 26 Jun 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts