{"id":19071940,"url":"https://github.com/cyansalt/commas","last_synced_at":"2025-04-10T02:26:55.663Z","repository":{"id":40693887,"uuid":"160184204","full_name":"CyanSalt/commas","owner":"CyanSalt","description":"A hackable, pluggable terminal, and also a command runner.","archived":false,"fork":false,"pushed_at":"2025-02-24T08:15:33.000Z","size":6184,"stargazers_count":65,"open_issues_count":2,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-04T19:42:13.137Z","etag":null,"topics":["electron","terminal"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CyanSalt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-03T12:00:52.000Z","updated_at":"2025-02-28T17:23:30.000Z","dependencies_parsed_at":"2023-11-13T08:32:02.878Z","dependency_job_id":"4cc2178c-a24b-4995-9988-1aff59f0d426","html_url":"https://github.com/CyanSalt/commas","commit_stats":null,"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyanSalt%2Fcommas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyanSalt%2Fcommas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyanSalt%2Fcommas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyanSalt%2Fcommas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CyanSalt","download_url":"https://codeload.github.com/CyanSalt/commas/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248143778,"owners_count":21054832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","terminal"],"created_at":"2024-11-09T01:32:54.888Z","updated_at":"2025-04-10T02:26:55.635Z","avatar_url":"https://github.com/CyanSalt.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Commas\n\n\u003cimg src=\"https://cdn.jsdelivr.net/gh/CyanSalt/commas@master/resources/images/icon.png\" width=\"96\"\u003e\n\nEN | [中文](docs/README-zh.md)\n\n**Commas** is a hackable, pluggable terminal, and also a command runner. The name comes from **Com**mand **Mas**ter.\n\n| Dark | Light |\n| --- | --- |\n| ![Screenshot](https://github.com/user-attachments/assets/0a478846-7079-46aa-9e2d-341e2de97dcc) | ![Screenshot](https://github.com/user-attachments/assets/56ccb758-0433-4295-af77-980d91642f24) |\n\n*Theme: [OneHalf](https://github.com/sonph/onehalf)*\n\n## Installation\n\n### Prebuilt version\n\n[Download the latest version](https://github.com/CyanSalt/commas/releases)\n\nIt can also be installed via [Homebrew](https://brew.sh/) (especially on macOS)\n\n```shell\nbrew install --cask cyansalt/cask/commas\n```\n\n\u003e [!WARNING]\n\u003e The prebuilt version of Windows or Linux don't work currently, see [#20](https://github.com/CyanSalt/commas/issues/20). It is recommended to build manually.\n\n### Build manually\n\nYou can clone or download the repository and build Commas locally.\n  - Make sure you have the latest LTS version of Node.js installed on your device.\n  - Download the source code and enter the directory through the command line.\n  - Run `pnpm install` to install dependencies\n  - Run `pnpm run build` to build this application for the current platform\n\n## Features\n\n- Multi-tab support with customizable layout\n- Duplicate or split from current terminal\n- Command completion based on [Fig specs](https://github.com/withfig/autocomplete)\n- Theme system compatible with Windows Terminal\n- Plug-in i18n support\n- Built-in addons\n  - Run commands instantly on local or remote server\n  - Interact with the application in the terminal\n  - Access the local file system, edit files, and open web pages in the application\n  - Visual settings editor\n  - Command completion or fix based on AI\n  - Take screenshots, record, or share terminal sessions via LAN\n  - Integration with [whistle](https://github.com/avwo/whistle) proxy\n  - Gist-based configuration synchronization\n  - Other easter egg features\n- User scripts and third-party addons\n\n## Customization\n\nAll of user data are stored in a separate **user data folder**, which is `~/Library/Application Support/Commas/` on macOS, `%localappdata%/Commas/` on Windows and `~/.config/Commas/` on Linux. These files can be shared between different devices. The configuration files (settings, key bindings, translations) are in YAML format, while the resource files (themes) are in JSON format.\n\n### Configuration\n\nYou can configure the application's interface and functionality at a granular level via `settings.yaml`. For example, to enable font ligatures in the terminal:\n\n```yaml\nterminal.style.fontLigatures: true\n```\n\nAdditionally, the built-in `settings` addon supports managing these configurations in graphical forms.\n\n### Theme\n\nCommas supports windowsterminal-compatible theme files. You can place theme files in the `themes` directory of the user data folder, and then specify the theme name through the settings.\n\nCommas will display a dark / light theme that follows your system's dark mode by default. You can specify the theme in dark / light mode separately, or you can change this behavior to keep the theme unchanged.\n\nThe built-in `theme` addon supports downloading themes from [windowsterminalthemes.dev](https://windowsterminalthemes.dev). There are currently 300+ available themes that can be downloaded and used.\n\n### I18n\n\nCommas currently has built-in supports for English and Simplified Chinese. You can also enable translation for other languages by adding / modifying the `translation.yaml` file under the user data folder. The content of the file can be something like part of [the translation file](https://github.com/CyanSalt/commas/blob/master/resources/locales/zh-CN.json).\n\nYou can also reference an existing translation file in the form of `@use: zh-CN` if you are using a dialect of one of the built-in languages.\n\n### Addons and user scripts\n\nCommas has several useful / interesting built-in [addons](https://github.com/CyanSalt/commas/tree/master/addons). In addition, you can also download / write third-party addons to be placed in the `addons` directory of the user data folder, and manage which addons you want to enable via settings.\n\nWith the built-in `addon-manager` addon, all built-in and self-added addons can be easily managed via a graphical interface.\n\nAdd-ons are based on a rich set of [hook APIs](https://github.com/CyanSalt/commas/tree/master/api). You can read the built-in addons for reference in writing your own addons. For some simple scenarios, you can add / modify the `custom.js` and `custom.css` files directly under the user data folder to implement custom logic and styles. `custom.js` also has full hook API support.\n\n### Developer tools\n\nThe best part is that you can use the shortcut key \u003ckbd\u003e⌘\u003c/kbd\u003e \u003ckbd\u003e⇧\u003c/kbd\u003e \u003ckbd\u003eI\u003c/kbd\u003e to open developer tool of Commas and inspect the HTML elements in the UI just like you would in a browser!\n\n## License\n\nISC \u0026copy; [CyanSalt](https://github.com/CyanSalt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyansalt%2Fcommas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyansalt%2Fcommas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyansalt%2Fcommas/lists"}