b6a478e1df
## Summary - Add portable installation tool (`install.sh`) for cross-machine setup - Add Claude.ai export files with proper YAML frontmatter - Add multi-agent-guide v2.0 with consolidated framework template - Rename `00-claude-code-setting` → `00-our-settings-audit` (avoid reserved word) - Add YAML frontmatter to 25+ SKILL.md files for Claude Desktop compatibility ## Commits Included - `93f604a` feat: Add portable installation tool for cross-machine setup - `9b84104` feat: Add Claude.ai export for portable skill installation - `f7ab973` fix: Add YAML frontmatter to Claude.ai export files - `3fed49a` feat(multi-agent-guide): Add v2.0 with consolidated framework - `3be26ef` refactor: Rename settings-audit skill and add YAML frontmatter Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
156 lines
3.6 KiB
Markdown
156 lines
3.6 KiB
Markdown
# OurDigital Shared Environment
|
|
|
|
Shared configuration, dependencies, and installation tools for OurDigital Skills package.
|
|
|
|
## Quick Install
|
|
|
|
```bash
|
|
# Clone the repository (on new machine)
|
|
git clone https://github.com/ourdigital/our-claude-skills.git
|
|
cd our-claude-skills/custom-skills/_ourdigital-shared
|
|
|
|
# Run installer
|
|
./install.sh
|
|
```
|
|
|
|
## Installation Options
|
|
|
|
```bash
|
|
./install.sh # Full interactive install
|
|
./install.sh --update # Update existing installation
|
|
./install.sh --uninstall # Remove installation
|
|
./install.sh --validate # Check installation status
|
|
./install.sh --skip-creds # Skip credentials setup
|
|
./install.sh --skip-venv # Skip virtual environment
|
|
./install.sh --help # Show all options
|
|
```
|
|
|
|
## What Gets Installed
|
|
|
|
| Component | Location | Description |
|
|
|-----------|----------|-------------|
|
|
| Environment file | `~/.env.ourdigital` | API keys and secrets |
|
|
| Config directory | `~/.ourdigital/` | Configuration and credentials |
|
|
| Virtual environment | `.venv-ourdigital/` | Python dependencies |
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
~/.ourdigital/
|
|
├── config.yaml # Global configuration
|
|
├── credentials/ # Service account JSONs
|
|
│ └── *.json
|
|
└── logs/ # Installation logs
|
|
|
|
~/.env.ourdigital # Environment variables (chmod 600)
|
|
```
|
|
|
|
## Manual Setup
|
|
|
|
If you prefer manual setup:
|
|
|
|
### 1. Create directories
|
|
```bash
|
|
mkdir -p ~/.ourdigital/credentials
|
|
chmod 700 ~/.ourdigital ~/.ourdigital/credentials
|
|
```
|
|
|
|
### 2. Copy environment template
|
|
```bash
|
|
cp .env.ourdigital.template ~/.env.ourdigital
|
|
chmod 600 ~/.env.ourdigital
|
|
```
|
|
|
|
### 3. Edit credentials
|
|
```bash
|
|
nano ~/.env.ourdigital
|
|
# Add your API keys
|
|
```
|
|
|
|
### 4. Create virtual environment
|
|
```bash
|
|
python3 -m venv .venv-ourdigital
|
|
source .venv-ourdigital/bin/activate
|
|
pip install -r requirements/base.txt
|
|
```
|
|
|
|
## Credentials Required
|
|
|
|
| Service | Variable | How to Get |
|
|
|---------|----------|------------|
|
|
| Notion | `NOTION_API_TOKEN` | [Notion Integrations](https://www.notion.so/my-integrations) |
|
|
| Ghost Blog | `GHOST_BLOG_ADMIN_KEY` | Ghost Admin → Integrations |
|
|
| Ghost Journal | `GHOST_JOURNAL_ADMIN_KEY` | Ghost Admin → Integrations |
|
|
| Figma | `FIGMA_ACCESS_TOKEN` | [Figma Settings](https://www.figma.com/developers/api#access-tokens) |
|
|
|
|
### Using 1Password CLI
|
|
|
|
If you have 1Password CLI (`op`) installed:
|
|
```bash
|
|
# Sign in
|
|
eval $(op signin)
|
|
|
|
# Installer will auto-fetch credentials
|
|
./install.sh
|
|
```
|
|
|
|
## Validation
|
|
|
|
Check your installation status:
|
|
|
|
```bash
|
|
# Quick check
|
|
./install.sh --validate
|
|
|
|
# Detailed check
|
|
python scripts/validate_install.py --verbose
|
|
```
|
|
|
|
## Cross-Machine Sync
|
|
|
|
To sync skills to another machine:
|
|
|
|
```bash
|
|
# On new machine
|
|
git clone https://github.com/ourdigital/our-claude-skills.git
|
|
cd our-claude-skills/custom-skills/_ourdigital-shared
|
|
./install.sh
|
|
|
|
# Credentials need to be set up separately (security)
|
|
# Either use 1Password CLI or manually copy ~/.env.ourdigital
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Permission denied
|
|
```bash
|
|
chmod +x install.sh
|
|
```
|
|
|
|
### Python version
|
|
```bash
|
|
# Check version (need 3.11+)
|
|
python3 --version
|
|
|
|
# Use pyenv if needed
|
|
pyenv install 3.11
|
|
pyenv local 3.11
|
|
```
|
|
|
|
### Missing credentials
|
|
```bash
|
|
# Check what's missing
|
|
python scripts/validate_install.py --verbose
|
|
```
|
|
|
|
## File Reference
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| `install.sh` | Main installer script |
|
|
| `.env.ourdigital.template` | Environment template |
|
|
| `config/ourdigital.yaml` | Default configuration |
|
|
| `requirements/base.txt` | Common dependencies |
|
|
| `requirements/code.txt` | Claude Code dependencies |
|
|
| `scripts/validate_install.py` | Installation validator |
|