pmx 0.1.0

A CLI tool for managing AI agent profiles across different platforms (Claude, Codex)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# PMX Documentation

PMX is a Rust CLI tool for managing Claude and Codex AI agent profile configurations. This documentation provides comprehensive information about the project's architecture, API, and usage.

## Table of Contents

- [Architecture Overview](./architecture.md) - High-level system design and component relationships
- [API Reference](./api.md) - Detailed documentation of all modules and functions
- [User Guide](./user-guide.md) - Complete usage examples and workflows
- [Development Guide](./development.md) - Information for contributors and developers

## Quick Links

### Core Components

- **CLI Interface** ([src/cli.rs](../src/cli.rs)) - Command-line argument parsing with clap
- **Storage System** ([src/storage.rs](../src/storage.rs)) - Profile storage and configuration management
- **Commands** ([src/commands/](../src/commands/)) - Modular command implementations

### Key Features

- **Profile Management**: Create, edit, delete, list, and copy AI agent profiles
- **Claude Integration**: Apply profiles to `~/.claude/CLAUDE.md`
- **Codex Integration**: Apply profiles to `~/.codex/AGENTS.md`
- **Auto-discovery**: Automatic configuration discovery and initialization
- **Shell Completions**: Built-in completion support for Zsh

## Getting Started

1. **Installation**: See [User Guide - Installation](./user-guide.md#installation)
2. **Basic Usage**: See [User Guide - Basic Commands](./user-guide.md#basic-commands)
3. **Configuration**: See [User Guide - Configuration](./user-guide.md#configuration)

## Project Structure

```
src/
├── main.rs              # Application entry point
├── lib.rs               # Library root
├── cli.rs               # Command-line interface definitions
├── storage.rs           # Storage and configuration management
├── utils.rs             # Shared utilities
├── commands.rs          # Commands module declaration
└── commands/
    ├── claude_code.rs   # Claude profile management
    ├── openai_codex.rs  # Codex profile management
    ├── profile.rs       # Profile CRUD operations
    └── utils.rs         # Utility commands (list, copy, completions)
```

## Key Design Principles

1. **Configuration-first**: Auto-discovery ensures the tool works without manual setup
2. **Modular Architecture**: Clear separation of concerns across modules
3. **Safety**: Comprehensive validation and error handling
4. **User Experience**: Intuitive commands with helpful feedback

## Contributing

See [Development Guide](./development.md) for information about:
- Setting up the development environment
- Running tests and linting
- Code style and conventions
- Submitting contributions