workmux-init

Generates a .workmux.yaml configuration by detecting project language and package manager.

4|Updated Sep 30, 2024
One-click install
npx skills add https://github.com/okm321/dotfiles --skill workmux-init-okm321
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: workmux-init
Source: https://github.com/okm321/dotfiles/tree/main/claude/skills/workmux-init
Command: npx skills add https://github.com/okm321/dotfiles --skill workmux-init-okm321

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Setting up workmux for a project requires manually writing a .workmux.yaml file with the correct install commands, environment file copies, and symlink entries. This Skill automates that setup by inspecting the project's lockfiles and config files to produce an appropriate configuration. ## Core Features & Use Cases - Project Detection: Identifies the language and package manager from files like pnpm-lock.yaml, Cargo.toml, go.mod, pyproject.toml, Gemfile, and composer.json, then selects the matching install command. - Environment File Handling: Detects .env.example, .env.sample, .env.template, and .env.local.example files and configures them as copy targets. - Symlink Suggestions: Proposes node_modules and .pnpm-store as symlink candidates for Node.js projects. - Git Exclusion: Adds .workmux.yaml to .git/info/exclude so the personal config stays out of version control. - Use Case: After cloning a pnpm-based Node.js repository, run the Skill to generate a .workmux.yaml with pnpm install as post_create and .env.example copied to .env. ## Quick Start Ask the assistant to run /workmux-init in your project root to detect the stack and generate a .workmux.yaml configuration file.

Frequently Asked Questions about workmux-init

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a .workmux.yaml file for my project?▼

Run the /workmux-init command in your project root. It detects your language and package manager from lockfiles and manifests, then writes a .workmux.yaml with the appropriate post_create install command and file copy rules.

What package managers does workmux-init detect?▼

It detects pnpm, yarn, and npm via lockfiles or package.json, plus Cargo for Rust, Go modules, uv/poetry/pip for Python, Bundler for Ruby, and Composer for PHP. Each maps to its standard install command.

Does workmux-init handle .env files automatically?▼

Yes. It searches for .env.example, .env.sample, .env.template, and .env.local.example files and configures them as copy targets in the generated .workmux.yaml so each new worktree gets its own environment file.

Will .workmux.yaml be committed to my git repository?▼

No. The Skill appends .workmux.yaml to .git/info/exclude, which acts as a personal gitignore. If the entry already exists, it is not duplicated, keeping the config out of version control.

When should I symlink node_modules in workmux?▼

Symlinking node_modules is suggested for Node.js projects to avoid reinstalling dependencies in every worktree. The Skill proposes node_modules and .pnpm-store as symlink candidates, but you can adjust the generated config manually.