sync-codex-dotfiles

Sync Codex global configuration into dotfiles while filtering machine-local state.

1|Updated Aug 16, 2023
One-click install
npx skills add https://github.com/monlor/dotfiles --skill sync-codex-dotfiles
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-codex-dotfiles
Source: https://github.com/monlor/dotfiles/tree/main/config/ai/agents/skills/sync-codex-dotfiles
Command: npx skills add https://github.com/monlor/dotfiles --skill sync-codex-dotfiles

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the process of syncing Codex global configuration from a local Codex directory into the dotfiles Codex config directory, ensuring a seamless and consistent configuration experience across devices.

Core Features & Use Cases

  • Automated Sync: Syncs Codex configuration without copying local machine state, such as credentials and runtime paths.
  • Filtering Machine-Local State: Ensures that only shared preferences, models, agents, features, plugins, profiles, and desktop-wide settings are synced.
  • Use Case: Ideal for users who want to update shared Codex settings or avoid copying local project trust, credentials, sessions, caches, and runtime paths.

Quick Start

To preview the sanitized sync, run:

~/.dotfiles/config/ai/agents/skills/sync-codex-dotfiles/scripts/sync-codex-dotfiles.py

Apply the changes after reviewing the diff with:

~/.dotfiles/config/ai/agents/skills/sync-codex-dotfiles/scripts/sync-codex-dotfiles.py --apply

Frequently Asked Questions about sync-codex-dotfiles

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

FAQPage Schema
How do I sync Codex global configuration into dotfiles without copying local state?

To sync Codex global configuration into dotfiles without copying local state, run the sync script to preview a sanitized diff of shared settings, then apply the changes. This process filters out machine-local credentials and runtime paths, ensuring only consistent preferences are synced across devices.

What is the best way to keep Codex settings consistent across multiple devices?

Keeping Codex settings consistent across multiple devices is best achieved by automating config synchronization into your dotfiles. This approach filters out machine-local state like project trust, caches, and credentials, ensuring that only shared preferences, models, and profiles are synced across machines.

How does the Codex dotfiles sync filtering mechanism work?

The Codex dotfiles sync filtering mechanism works by extracting global configuration from your local Codex directory and filtering out machine-local state. It specifically isolates shared preferences, agents, features, and plugins while excluding local project data, sessions, credentials, and runtime paths from the sync.

How do I preview sanitized Codex config changes before applying them to dotfiles?

To preview sanitized Codex config changes before applying them to dotfiles, execute the sync script without arguments. This generates a diff of the sanitized configuration, allowing you to review the shared settings before applying the changes with the apply flag.

Can I use this config automation script to sync credentials and sessions to my dotfiles?

You cannot use this config automation script to sync credentials and sessions to your dotfiles. The sync mechanism is specifically designed to filter out machine-local state, including credentials, sessions, caches, and local project trust, ensuring only shared preferences are synced across devices.

When do I need to automate Codex configuration management for dotfiles?

You need to automate Codex configuration management for dotfiles when you require consistent settings across multiple devices and want to avoid manually duplicating local project data. This is ideal for maintaining shared preferences, models, agents, and desktop-wide settings without copying sensitive machine-local state.