claudes-office/README.md

CLI tool to initialize Claude's office in your project

# Claude's Office CLI

A command-line tool to quickly initialize Claude's Office organizational structure in your project, customized for your specific technology stack. Now with TypeScript support and update functionality!

## What is Claude's Office?

Claude's Office is an organizational system that enhances Claude AI's capabilities by providing:

1. A consistent organizational structure for project documents
2. Role-specific context to help Claude adopt different perspectives based on your tech stack
3. Clear separation between planning, reference materials, and implementation
4. A framework for tracking progress and maintaining project status

## Installation

```bash
# Install globally
npm install -g claudes-office

# Or use with npx
npx claudes-office init
```

## Usage

```bash
# Initialize Claude's office in the current directory with interactive customization
claudes-office init

# Add roles to an existing installation
claudes-office add-roles

# Update an existing installation to the latest version
claudes-office update

# Get help
claudes-office --help
```

## Interactive Setup Wizard

The initialization process now includes an interactive wizard that:

1. Guides you through selecting your project type (Frontend, Backend, Full Stack, Mobile, Data Science)
2. Allows you to choose specific frameworks and technologies you're using:
   - Frontend: React, Vue, Angular, Svelte
   - Backend: Express, NestJS, Django, Flask, FastAPI, Ruby on Rails
   - Mobile: React Native, Flutter
   - Data Science: Data Science tools, Machine Learning
3. Customizes the roles directory to include only the relevant expert roles for your project
4. Provides a summary of selected options before completing the installation

## What Gets Installed

Running the init command creates the following in your project:

- `CLAUDE.md`: Main guide for Claude to understand the office system
- `Initialize_Project.md`: Instructions for setting up the office for a specific project
- `claudes-office/`: Directory containing the customized office structure with:
  - Project-specific role guidance files based on your tech stack
  - Generic roles applicable to all projects
  - Reference materials directory
  - Work sessions tracking
  - Planning documents structure
  - Task management system
  - And more...

## Role Organization

Roles are now organized into two main categories:

1. **Generic Roles**: Core roles applicable to all projects (architect, dev lead, project manager, etc.)
2. **Project-Specific Roles**: Technology-specific roles organized by domain (frontend, backend, mobile, data, devops)

## Working with Claude

When working with Claude on your project, you should:

1. Remind Claude to check the CLAUDE.md file at the beginning of your conversations
2. Ask Claude to adopt specific roles from the roles directory when tackling specialized tasks
   - For example: "Please use the nestjs_expert role for this backend task"
3. Let Claude use the office structure to organize its work and maintain context

## New in Version 0.4.0

### TypeScript Support
- The entire codebase has been migrated to TypeScript
- Improved type safety and maintainability
- Enhanced developer experience with better code organization

### Update Command
- Safely update existing installations with `claudes-office update`
- Backup system to protect your customizations
- Selective component updates
- Update notifications in your CLAUDE.md file

### Meeting Functionality (Coming in v1.0)
- Initial framework for meeting organization
- Full AI-powered meeting generation planned for v1.0

## License

MIT