Configs

中文 README

Configs is a macOS application designed to help you easily manage and edit your configuration files. Based on SwiftUI.

It automatically scans for common configuration files across various programming languages and tools, provides a convenient interface for viewing and editing them, and allows you to add your own custom configuration files.

Screenshots

Features

• Automatic Discovery: Scans your home directory for common configuration files (e.g., .zshrc, .gitconfig, .vimrc, .npmrc, etc.).

• Automatic source: When editing files like .zshrc and .bashrc, it automatically executes source ~/.zshrc, making changes take effect immediately.

• Version Control: Built-in Git-based version tracking system that automatically creates commits when you save files, allowing you to:

  • View complete version history for each configuration file
  • Compare changes between different versions with diff view
  • Restore any previous version with one click
  • Smart commit messages using the current cursor line content or timestamp

• File Management: Add custom configuration files, pin frequently used files for quick access, and delete custom files.

• Code Editor: Integrated code editor with syntax highlighting for various file types.

• Search Functionality: Search for specific configuration files by name or path in the sidebar, and search within the content of the currently open file.

• Zoom Control: Adjust the zoom level of the editor content.

• Appearance Options: Switch between light and dark mode.

• Keyboard Shortcuts:

  • Cmd + F: Show/Hide Search Bar in the editor.
  • Cmd + S: Save File.
  • Cmd + /: Toggle comment on selected lines.
  • Cmd + = / Cmd + +: Zoom In.
  • Cmd + -: Zoom Out.
  • Cmd + 0: Reset Zoom.
  • Esc: Close Search Bar.

• Context Menu Actions: Right-click on a file in the sidebar for options like:

  • Pin/Unpin
  • Copy Path
  • Open in Finder
  • Open in VSCode
  • Open in Cursor
  • Open in Terminal

• Version History Sidebar: Click the history button in the toolbar to view:

  • Complete commit history with timestamps
  • Diff view showing exact changes made
  • One-click restore functionality
  • Smart commit messages based on your edits

Installation

To install and run Configs, you will need Xcode installed on your macOS machine.

1. Clone the repository:

   git clone https://github.com/iHongRen/configEditor.git
   cd configEditor/Configs

2. Open in Xcode: Open the Configs.xcodeproj file in Xcode.

3. Build the Application: Select your target (e.g., "My Mac") and click the "Build" button (⌘B) in Xcode. The Configs.app will be generated in the Products folder within Xcode's project navigator. You can right-click on Configs.app and select "Show in Finder" to locate it.

4. Install and Run: unzip Configs.zip , drag the Configs.app bundle to your /Applications folder. Open Terminal and run the following command to make the application executable:

   chmod +x /Applications/Configs.app/Contents/MacOS/Configs

   You can now open the application from your /Applications folder or Launchpad.

   If you encounter a popup warning about the application not being trusted, go to System Preferences > Privacy & Security > Security > Allow Applications from the App Store and Known Developers > Open Anyway