npx @prarthana25/teams-cli login
npx @prarthana25/teams-cli team list

🎯 Quick Start

1️⃣ Login with GitHub

teams login

2️⃣ Create and Manage Teams

# Create a new team
teams team create "MyAwesomeTeam"

# List your teams
teams team list

# Get team details
teams team get 1

3️⃣ Manage Team Members

# Add a member to a team
teams member add --team-id 1 --username octocat

# List team members
teams member list --team-id 1

# Remove a member
teams member remove --team-id 1 --user-id 5

4️⃣ Invite System

# Send an invite to a new user
teams invite send --team-id 1 --username newuser

# Accept an invite using code
teams invite accept --code ABC12345XYZ

# List pending invites
teams invite list --team-id 1

5️⃣ Repository Management

# Add a GitHub repository to a team
teams repo add --team-id 1 --url https://github.com/user/repo

# List repositories
teams repo list --team-id 1

6️⃣ View Analytics

# Get team activity summary
teams analytics summary --team-id 1

# View detailed analytics
teams analytics details --team-id 1

📚 Complete Command Reference

Authentication

teams login              # Authenticate with GitHub
teams logout             # Sign out and clear tokens
teams whoami             # Show current logged-in user

Team Operations

teams team list          # List all teams
teams team create NAME   # Create a new team
teams team get ID        # Get team details
teams team delete ID     # Delete a team

Member Operations

teams member list --team-id ID       # List team members
teams member add --team-id ID --username USERNAME    # Add a member
teams member remove --team-id ID --user-id USER_ID   # Remove a member

Repository Operations

teams repo list --team-id ID            # List team repositories
teams repo add --team-id ID --url URL   # Add a repository
teams repo remove --team-id ID --repo-id REPO_ID

Invite Operations

teams invite list --team-id ID          # List invites
teams invite send --team-id ID --username USERNAME  # Send invite
teams invite accept --code CODE         # Accept invite

Analytics

teams analytics summary --team-id ID    # Team activity summary
teams analytics commits --repo-id ID    # Commit statistics

System

teams help              # Show help information
teams version           # Display version

🏗️ Project Structure

Teams-CLI/
├── src/
│   ├── api/                    # REST API server
│   │   ├── server.ts           # Express server setup
│   │   ├── redis.ts            # Redis client configuration
│   │   └── rateLimiter.ts      # Rate limiting middleware
│   │
│   ├── cli/                    # CLI command handlers
│   │   ├── command.ts          # Command registration & routing
│   │   ├── auth.ts             # Authentication commands
│   │   ├── team.ts             # Team commands
│   │   ├── github.ts           # GitHub integration
│   │   └── help.ts             # Help documentation
│   │
│   ├── controllers/            # API request handlers
│   │   ├── team.controller.ts
│   │   ├── user.controller.ts
│   │   ├── repo.controller.ts
│   │   ├── commit.controller.ts
│   │   ├── invite.controller.ts
│   │   └── analytics.controller.ts
│   │
│   ├── services/               # Business logic layer
│   │   ├── github.services.ts  # GitHub API interactions
│   │   ├── npm.services.ts     # NPM operations
│   │   └── analytics.services.ts
│   │
│   ├── utils/                  # Utility functions
│   │   ├── logger.ts           # Logging utility
│   │   ├── spinner.ts          # CLI spinner
│   │   ├── inquirer.ts         # Interactive prompts
│   │   └── currentUser.ts
│   │
│   ├── config/                 # Configuration
│   │   └── auth.config.ts      # Auth configuration
│   │
│   ├── core/                   # Core functionality
│   │   └── cron.analytics.ts   # Scheduled analytics
│   │
│   ├── db/                     # Database layer
│   │   └── prisma.ts           # Prisma client initialization
│   │
│   ├── test/                   # Test files
│   │   ├── teams.test.ts
│   │   ├── user.test.ts
│   │   ├── repo.test.ts
│   │   ├── commit.test.ts
│   │   └── invite.test.ts
│   │
│   ├── index.ts                # CLI entry point
│   └── api.ts                  # API entry point
│
├── prisma/                     # Database ORM
│   ├── schema.prisma           # Database schema
│   └── migrations/             # Database migrations
│
├── scripts/                    # Build & utility scripts
│   └── pre-publish-check.ts
│
├── docker-compose.yml          # Docker services (PostgreSQL, Redis)
├── Dockerfile                  # Docker image
├── jest.config.ts              # Jest testing configuration
├── tsconfig.json               # TypeScript configuration
├── package.json                # Dependencies
└── README.md                   # This file

🚀 Getting Started

📋 Prerequisites

• Node.js 18.0.0 or higher
• npm 9.0.0 or higher
• PostgreSQL 12+ (for database)
• Redis 6+ (for caching & rate limiting)
• GitHub Account (for OAuth)

🔧 Installation Steps

Step 1: Clone Repository

git clone https://github.com/hitoriiiiiiii/Teams-Cli.git
cd Teams-CLI

Step 2: Install Dependencies

npm install

Step 3: Configure Environment Variables

Create a .env file in the root directory:

# Database Configuration
DATABASE_URL="postgresql://user:password@localhost:5432/teams_db"

# Redis Configuration
REDIS_URL="redis://localhost:6379"

# GitHub OAuth
GITHUB_CLIENT_ID="your-github-oauth-client-id"
GITHUB_CLIENT_SECRET="your-github-oauth-client-secret"
GITHUB_TOKEN="your-github-personal-access-token"

# API Configuration
PORT=3000
NODE_ENV=development

How to Get GitHub OAuth Credentials:

1. Go to GitHub Settings → Developer settings → OAuth Apps
2. Create a new OAuth application
3. Set Authorization callback URL to http://localhost:3000/auth/github/callback
4. Copy the Client ID and Client Secret to your .env

Step 4: Set Up Database

# Run Prisma migrations
npx prisma migrate deploy

# Generate Prisma client
npx prisma generate

# (Optional) Seed test data
ts-node setup-test-user.ts

Step 5: Start the Application

For CLI Development:

npm run dev

For REST API:

npm run api

For Production:

npm run build
npm start

🌐 REST API

Server Setup

Start the API server:

npm run api

The server will be available at http://localhost:3000

API Endpoints Overview

Health & Status

GET  /health              → Check API health

Teams

GET    /api/teams                    → List all teams
POST   /api/teams                    → Create new team
GET    /api/teams/:id                → Get team details
PUT    /api/teams/:id                → Update team
DELETE /api/teams/:id                → Delete team
GET    /api/teams/:id/members        → List team members
GET    /api/teams/:id/repos          → List team repositories
GET    /api/teams/:id/analytics      → Get team analytics

Users

GET    /api/users                    → List all users
GET    /api/users/:id                → Get user details
GET    /api/users/:id/teams          → Get user's teams

Repositories

GET    /api/repos                    → List all repositories
POST   /api/repos                    → Add repository
GET    /api/repos/:id                → Get repository details
DELETE /api/repos/:id                → Delete repository
GET    /api/repos/:id/commits        → Get repository commits

Commits

GET    /api/commits                  → List all commits
GET    /api/commits/:id              → Get commit details
GET    /api/repos/:id/commits        → List commits for a repository

Invites

GET    /api/invites                  → List all invites
POST   /api/invites                  → Create invite
POST   /api/invites/:code/accept     → Accept invite
DELETE /api/invites/:id              → Cancel invite

Analytics

GET    /api/analytics/summary        → Overall statistics
GET    /api/analytics/teams/:id      → Team analytics
GET    /api/analytics/repos/:id      → Repository analytics

Authentication

All API requests (except health check and OAuth) require a Bearer token:

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     http://localhost:3000/api/teams

Example API Requests

Create a Team:

curl -X POST http://localhost:3000/api/teams \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Frontend Team",
    "description": "Our awesome frontend team"
  }'

Add Repository to Team:

curl -X POST http://localhost:3000/api/repos \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "teamId": 1,
    "url": "https://github.com/user/repo-name"
  }'

🔒 Security & Rate Limiting

Rate Limiting

The API implements comprehensive rate limiting powered by Redis:

See API_RATE_LIMITING.md for advanced configuration.

Security Features

✅ GitHub OAuth 2.0 - Secure token-based authentication
✅ CORS Protection - Configured cross-origin access
✅ Input Validation - Comprehensive parameter validation
✅ Token Encryption - Secure token storage in database
✅ Rate Limiting - Prevent brute force and DDoS attacks

🧪 Testing

Run All Tests

npm test

Run Tests with Coverage

npm test -- --coverage

Run Specific Test File

npm test -- teams.test.ts

Watch Mode (for development)

npm test -- --watch