Getting Started

Usage

Learn how to configure and customize codetie for your IDEs.

codetie offers a simple CLI approach. Whether you’re working with Cursor, Windsurf, Cline, or GitHub Copilot, you can quickly bootstrap and share AI rules among different editors.

Basic Commands

  • Initialize:
npx codetie@latest init

Creates or updates configuration for your default IDE (cursor) unless otherwise specified.

  • Specify IDE:
npx codetie@latest init --ide copilot

This sets up .github/copilot-instructions.md with recommended rules for Copilot.

  • Force Overwrite:
npx codetie@latest init --force

Overrides existing configuration files without prompting.

Example Workflow

  1. Init:
    npx codetie@latest init --ide cursor
    

    This creates .cursor/rules/ along with recommended codetie AI guidelines.
  2. Customize: Open .cursor/rules/ to tweak your AI instructions, coding standards, or naming conventions.
  3. Commit:
    git add .
    git commit -m "Add custom codetie configuration for Cursor"
    
  4. Switch IDE:
    npx codetie@latest init --ide windsurf
    

    Now you have .windsurfrules with the same best practices, ensuring consistent AI behavior across both editors.

That’s it! In just a few steps, codetie saves you from re-creating AI instructions when switching between multiple IDEs.


Copyright © 2023