๐ฆ Installation Guide
Get started with Danang Nightlife in minutes.
โ๏ธ What You Need
Before installing, make sure you have:
| Requirement | Description |
|---|---|
| Operating System | Linux, macOS, or Windows (PowerShell supported) |
| AI Assistant | Claude Code, GitHub Copilot, Gemini CLI, or CodeBuddy CLI |
| Package Manager | uv |
| Python | Version 3.11 or higher |
| Version Control | Git |
๐ Installation Options
Option 1: Create a New Project
The easiest way to start:
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init <PROJECT_NAME>
Option 2: Initialize in Current Directory
Already have a project folder?
# Method 1: Using dot notation
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init .
# Method 2: Using --here flag
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init --here
๐ค Choose Your AI Agent
Specify which AI assistant to use:
# Claude Code
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init <project_name> --ai claude
# Gemini CLI
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init <project_name> --ai gemini
# GitHub Copilot
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init <project_name> --ai copilot
# CodeBuddy CLI
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init <project_name> --ai codebuddy
๐ง Script Type (Python)
All automation scripts are now Python-based for cross-platform compatibility:
Default behavior:
- ๐ง All platforms โ Python (
.py) - ๐ฌ Interactive mode โ You'll be asked if needed
โก Skip Tool Checks (Optional)
Want to set up without checking if AI tools are installed?
uvx --from git+https://github.com/dauquangthanh/danang-nightlife.git nightlife init <project_name> --ai claude --ignore-agent-tools
Use this when: You're setting up on a different machine or want to configure tools later.
โ Verify Installation
After setup, check that everything works:
1. Check for Slash Commands
Your AI agent should show these core commands:
Core Workflow:
| Command | Purpose |
|---|---|
/nightlife.set-ground-rules |
Set project principles |
/nightlife.specify |
Create specifications |
/nightlife.design |
Generate implementation plans |
/nightlife.taskify |
Break down into actionable tasks |
/nightlife.implement |
Execute the plan |
2. Check Script Files
Each command's scripts live inside the agent folder, e.g.:
ls .claude/commands/specify/scripts/ # Claude Code
ls .github/agents/specify/scripts/ # GitHub Copilot
- โ
Python scripts (
.py) for cross-platform execution, onescripts/folder per command
๐ ๏ธ Troubleshooting
Git Authentication Issues on Linux
Having trouble with Git authentication? Install Git Credential Manager:
#!/usr/bin/env bash
set -e
echo "โฌ๏ธ Downloading Git Credential Manager v2.6.1..."
wget https://github.com/git-ecosystem/git-credential-manager/releases/download/v2.6.1/gcm-linux_amd64.2.6.1.deb
echo "๐ฆ Installing..."
sudo dpkg -i gcm-linux_amd64.2.6.1.deb
echo "โ๏ธ Configuring Git..."
git config --global credential.helper manager
echo "๐งน Cleaning up..."
rm gcm-linux_amd64.2.6.1.deb
echo "โ
Done! Git Credential Manager is ready."
Need More Help?
- ๐ Check the Quick Start Guide for next steps
- ๐ Report an issue if something's not working
- ๐ฌ Ask questions in our community