console-cowboy 0.3.0__tar.gz

console_cowboy-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

console_cowboy-0.3.0/PKG-INFO

@@ -0,0 +1,437 @@
+Metadata-Version: 2.4
+Name: console-cowboy
+Version: 0.3.0
+Summary: Hop terminals like you hop linux distributions.
+Author: zetlen
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/zetlen/console-cowboy
+Project-URL: Changelog, https://github.com/zetlen/console-cowboy/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/zetlen/console-cowboy/issues
+Project-URL: CI, https://github.com/zetlen/console-cowboy/actions
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: lupa>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tomli>=2.0
+Requires-Dist: tomli-w>=1.0
+Dynamic: license-file
+
+# console-cowboy
+
+[![PyPI](https://img.shields.io/pypi/v/console-cowboy.svg)](https://pypi.org/project/console-cowboy/)
+[![Changelog](https://img.shields.io/github/v/release/zetlen/console-cowboy?include_prereleases&label=changelog)](https://github.com/zetlen/console-cowboy/releases)
+[![Tests](https://github.com/zetlen/console-cowboy/actions/workflows/test.yml/badge.svg)](https://github.com/zetlen/console-cowboy/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/zetlen/console-cowboy/blob/master/LICENSE)
+
+**Hop terminals like you hop Linux distributions.**
+
+Console Cowboy is a CLI tool for making terminal configurations portable across different terminal emulators. Export your settings from one terminal and import them into another.
+
+## Features
+
+- **Portable Configuration Format**: Uses CTEC (Common Terminal Emulator Configuration) as an intermediate representation
+- **Multiple Terminal Support**: Import and export configurations for:
+  - iTerm2
+  - Ghostty
+  - Alacritty
+  - Kitty
+  - Wezterm
+  - Terminal.app (macOS)
+  - VS Code (integrated terminal)
+- **Automatic Format Detection**: Detects terminal config formats automatically from file contents
+- **Smart Path Resolution**: Use terminal names to read/write to default config locations
+- **iTerm2-Color-Schemes Compatible**: Color schemes use the same YAML format as the popular [iTerm2-Color-Schemes](https://github.com/mbadolato/iTerm2-Color-Schemes) project
+- **Quick Terminal Support**: Migrate quake-style dropdown terminal settings between iTerm2, Ghostty, and Kitty
+- **Stdin/Stdout Support**: Pipe configs through shell pipelines
+- **Incompatibility Reporting**: Clearly reports which settings cannot be converted between terminals
+- **Terminal-Specific Settings**: Preserves terminal-specific settings that don't have equivalents in other terminals
+
+## Installation
+
+Install using `uv` (recommended):
+
+```bash
+uv tool install console-cowboy
+```
+
+Or with `pip`:
+
+```bash
+pip install console-cowboy
+```
+
+Or with `pipx` for isolated installation:
+
+```bash
+pipx install console-cowboy
+```
+
+## Quick Start
+
+### Convert between terminals
+
+```bash
+# Convert iTerm2 settings directly to Ghostty config
+console-cowboy --from iterm2 --to ghostty
+
+# Convert from a specific file to a terminal's default location
+console-cowboy --from ~/path/to/config --to ghostty
+
+# Convert between specific files
+console-cowboy --from config.lua --from-type wezterm --to config.toml --to-type alacritty
+```
+
+### Export to portable CTEC format
+
+```bash
+# Export iTerm2 config to CTEC (outputs to stdout)
+console-cowboy --from iterm2
+
+# Export to a file
+console-cowboy export --from kitty --to my-config.yaml
+
+# Export a specific iTerm2 profile
+console-cowboy export --from iterm2 --profile "Development"
+```
+
+### Import from CTEC format
+
+```bash
+# Import CTEC to a terminal's default location
+console-cowboy import --from my-config.yaml --to ghostty
+
+# Import to a specific file
+console-cowboy import --from my-config.yaml --to ~/.config/alacritty/alacritty.toml --to-type alacritty
+
+# Preview import without saving (output to stdout)
+console-cowboy import --from my-config.yaml --to-type wezterm
+```
+
+### Use with pipes
+
+```bash
+# Pipe between commands
+console-cowboy --from iterm2 | console-cowboy import --from - --to ghostty
+
+# Read from stdin
+cat my-config.yaml | console-cowboy --from - --from-type ctec --to-type kitty
+```
+
+## CLI Reference
+
+Console Cowboy uses `--from` and `--to` flags for all operations. The implicit command is conversion; explicit `export`, `import`, and `convert` commands are also available.
+
+### Default Command (Convert)
+
+```bash
+console-cowboy [--from SOURCE] [--from-type TYPE] [--to DEST] [--to-type TYPE] [--profile NAME] [--quiet]
+```
+
+The `--from` and `--to` arguments accept:
+- **Terminal name**: `iterm2`, `ghostty`, `alacritty`, `kitty`, `wezterm`, `vscode`, `terminal_app` - reads from/writes to the terminal's default config location
+- **File path**: Path to a config file
+- **`-`**: Read from stdin / write to stdout
+
+Type detection:
+- If a terminal name is given, that format is used
+- If a file path is given, the format is auto-detected from content
+- Use `--from-type` or `--to-type` to override: `ctec` or a terminal name
+
+Behavior:
+- `--from` without `--to`: Outputs CTEC to stdout
+- `--from` with `--to`: Converts and writes to destination
+- `--to-type` without `--to`: Outputs that format to stdout
+
+Options:
+- `--from`: Source (terminal name, file path, or `-` for stdin)
+- `--from-type`: Explicit source type (`ctec` or terminal name)
+- `--to`: Destination (terminal name, file path, or `-` for stdout)
+- `--to-type`: Explicit destination type (`ctec` or terminal name)
+- `--profile`: Profile name (iTerm2/Terminal.app only)
+- `--quiet`: Suppress warnings and informational output
+
+### `export`
+
+Export a terminal's configuration to CTEC format (always YAML).
+
+```bash
+console-cowboy export --from SOURCE [--from-type TYPE] [--to OUTPUT] [--profile NAME] [--quiet]
+```
+
+Options:
+- `--from`: Source terminal or config file (required)
+- `--from-type`: Explicit source type (terminal name)
+- `--to`: Output file (defaults to stdout)
+- `--profile`: Profile name (iTerm2/Terminal.app only)
+- `--quiet`: Suppress warnings
+
+### `import`
+
+Import a CTEC configuration into a terminal's native format.
+
+```bash
+console-cowboy import --from CTEC_FILE [--to DEST] [--to-type TYPE] [--quiet]
+```
+
+Options:
+- `--from`: CTEC file path or `-` for stdin (required)
+- `--to`: Destination terminal or file
+- `--to-type`: Explicit destination type (terminal name, required if `--to` is a file)
+- `--quiet`: Suppress warnings
+
+### `convert`
+
+Convert directly between terminal configuration formats.
+
+```bash
+console-cowboy convert --from SOURCE --to DEST [--from-type TYPE] [--to-type TYPE] [--profile NAME] [--quiet]
+```
+
+Options:
+- `--from`: Source terminal or config file (required)
+- `--to`: Destination terminal or file (required)
+- `--from-type`: Explicit source type
+- `--to-type`: Explicit destination type
+- `--profile`: Profile name (iTerm2/Terminal.app source only)
+- `--quiet`: Suppress warnings
+
+### `list`
+
+List all supported terminal emulators.
+
+```bash
+console-cowboy list
+```
+
+### `info`
+
+Display information about a configuration file.
+
+```bash
+console-cowboy info --from SOURCE [--from-type TYPE]
+```
+
+## Example Workflows
+
+### Migrate from iTerm2 to Ghostty
+
+```bash
+# Direct conversion to Ghostty's default config location
+console-cowboy --from iterm2 --to ghostty
+```
+
+### Backup your terminal config
+
+```bash
+# Export to a portable format
+console-cowboy export --from ghostty --to ~/backups/terminal-config.yaml
+```
+
+### Test a config on another terminal
+
+```bash
+# Preview how your config would look in Kitty
+console-cowboy --from ~/.config/alacritty/alacritty.toml --to-type kitty
+
+# Or pipe it for processing
+console-cowboy --from wezterm | less
+```
+
+### Use in scripts
+
+```bash
+# Convert multiple terminals in a script
+for terminal in ghostty alacritty kitty; do
+  console-cowboy --from iterm2 --to-type $terminal > ~/configs/$terminal-config
+done
+```
+
+## CTEC Format
+
+The Common Terminal Emulator Configuration (CTEC) format is a portable YAML representation of terminal settings. It captures:
+
+### Color Scheme
+- Foreground and background colors
+- Cursor and selection colors
+- Full 16-color ANSI palette (normal and bright variants)
+
+### Font Configuration
+- Font family, size, and line height
+- Bold and italic font variants
+- Ligature support
+
+### Cursor Configuration
+- Style (block, beam, underline)
+- Blink behavior and interval
+
+### Window Configuration
+- Initial dimensions (columns/rows)
+- Opacity and blur effects
+- Padding and decorations
+- Startup mode
+
+### Behavior Configuration
+- Default shell
+- Scrollback buffer size
+- Bell mode (audible, visual, none)
+- Copy-on-select behavior
+
+### Key Bindings
+- Keyboard shortcuts with modifiers
+
+### Terminal-Specific Settings
+Settings that cannot be mapped to common CTEC fields are preserved in a `terminal_specific` section, allowing them to be restored when converting back to the same terminal.
+
+### Example CTEC File
+
+```yaml
+version: "1.0"
+source_terminal: ghostty
+
+color_scheme:
+  name: Tomorrow Night
+  foreground: "#c5c8c6"
+  background: "#1d1f21"
+  cursor: "#c5c8c6"
+  black: "#1d1f21"
+  red: "#cc6666"
+  green: "#b5bd68"
+  yellow: "#f0c674"
+  blue: "#81a2be"
+  magenta: "#b294bb"
+  cyan: "#8abeb7"
+  white: "#c5c8c6"
+
+font:
+  family: JetBrains Mono
+  size: 14.0
+  ligatures: true
+
+cursor:
+  style: block
+  blink: true
+  blink_interval: 500
+
+window:
+  columns: 120
+  rows: 40
+  opacity: 0.95
+
+behavior:
+  shell: /bin/zsh
+  bell_mode: visual
+
+scroll:
+  lines: 10000
+
+key_bindings:
+  - action: Copy
+    key: c
+    mods:
+      - ctrl
+      - shift
+```
+
+## Supported Terminals
+
+| Terminal | Config Format | Import | Export | Quick Terminal |
+|----------|--------------|--------|--------|----------------|
+| iTerm2 | plist XML | Yes | Yes | Yes |
+| Ghostty | key=value | Yes | Yes | Yes |
+| Alacritty | TOML/YAML | Yes | Yes | No |
+| Kitty | key value | Yes | Yes | Yes |
+| Wezterm | Lua | Yes | Yes | No |
+| VS Code | JSON | Yes | Yes | No |
+| Terminal.app | plist XML | Yes | Yes | No |
+
+### Default Config Locations
+
+- **iTerm2**: `~/Library/Preferences/com.googlecode.iterm2.plist`
+- **Ghostty**: `~/.config/ghostty/config`
+- **Alacritty**: `~/.config/alacritty/alacritty.toml` or `.yml`
+- **Kitty**: `~/.config/kitty/kitty.conf`
+- **Wezterm**: `~/.wezterm.lua` or `~/.config/wezterm/wezterm.lua`
+- **VS Code**: `~/Library/Application Support/Code/User/settings.json` (macOS) or `~/.config/Code/User/settings.json` (Linux)
+- **Terminal.app**: `~/Library/Preferences/com.apple.Terminal.plist`
+
+## Compatibility Notes
+
+Not all settings can be perfectly converted between terminals:
+
+1. **Color Formats**: All terminals use slightly different color representations. Console Cowboy normalizes to hex colors (e.g., `#c5c8c6`) compatible with the iTerm2-Color-Schemes format.
+
+2. **Font Handling**: Font names may need adjustment depending on how each terminal resolves fonts.
+
+3. **Key Bindings**: Different terminals have different action names and modifier key representations. Key bindings are converted on a best-effort basis.
+
+4. **Wezterm Lua**: Wezterm uses Lua for configuration. Console Cowboy can parse common patterns but complex Lua configurations may not be fully captured.
+
+5. **Terminal-Specific Features**: Features unique to one terminal (like iTerm2's "Unlimited Scrollback" or Kitty's remote control) are preserved but only work when converting back to the same terminal.
+
+6. **Terminal.app NSKeyedArchiver**: Terminal.app uses Apple's NSKeyedArchiver format for colors and fonts. Console Cowboy can parse this format, but for best accuracy on macOS, installing PyObjC (`uv pip install pyobjc-framework-Cocoa`) is recommended.
+
+7. **Quick Terminal / Hotkey Window**: Quake-style dropdown terminal settings can be migrated between iTerm2, Ghostty, and Kitty. Alacritty, Wezterm, and VS Code don't have native quick terminal support.
+
+8. **VS Code**: VS Code's integrated terminal has limited customization compared to dedicated terminal emulators. Only colors, fonts, cursor, and basic behavior settings are supported.
+
+Console Cowboy will report any incompatibilities or settings that couldn't be converted.
+
+## Development
+
+To contribute to this tool, first checkout the code:
+
+```bash
+git clone https://github.com/zetlen/console-cowboy
+cd console-cowboy
+```
+
+Install dependencies with [uv](https://docs.astral.sh/uv/) (recommended):
+
+```bash
+uv sync --all-extras
+```
+
+Run the tests:
+
+```bash
+uv run pytest
+```
+
+Run tests with coverage:
+
+```bash
+uv run pytest --cov=console_cowboy
+```
+
+Run the CLI during development:
+
+```bash
+uv run console-cowboy --help
+```
+
+## License
+
+Apache 2.0
+
+## Contributing
+
+Contributions are welcome! Repo's open.
+
+### Adding Support for New Terminals
+
+1. Create a new adapter in `console_cowboy/terminals/`
+2. Inherit from `TerminalAdapter`
+3. Implement `parse()` and `export()` methods
+4. Register the adapter in `console_cowboy/terminals/__init__.py`
+5. Add test fixtures and tests