{"id":13527925,"url":"https://github.com/xi-editor/xi-mac","last_synced_at":"2025-05-15T03:08:19.374Z","repository":{"id":42535499,"uuid":"78881023","full_name":"xi-editor/xi-mac","owner":"xi-editor","description":"The xi-editor mac frontend.","archived":false,"fork":false,"pushed_at":"2021-09-05T12:08:02.000Z","size":4584,"stargazers_count":3025,"open_issues_count":51,"forks_count":144,"subscribers_count":55,"default_branch":"master","last_synced_at":"2025-04-14T03:11:23.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xi-editor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-13T19:46:46.000Z","updated_at":"2025-04-05T08:55:22.000Z","dependencies_parsed_at":"2022-09-07T13:01:00.825Z","dependency_job_id":null,"html_url":"https://github.com/xi-editor/xi-mac","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xi-editor%2Fxi-mac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xi-editor%2Fxi-mac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xi-editor%2Fxi-mac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xi-editor%2Fxi-mac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xi-editor","download_url":"https://codeload.github.com/xi-editor/xi-mac/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254264770,"owners_count":22041794,"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":[],"created_at":"2024-08-01T06:02:06.852Z","updated_at":"2025-05-15T03:08:14.352Z","avatar_url":"https://github.com/xi-editor.png","language":"Swift","funding_links":[],"categories":["Swift","HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"[![Build Status](https://travis-ci.com/xi-editor/xi-mac.svg?branch=master)](https://travis-ci.com/xi-editor/xi-mac)\n[![codecov](https://codecov.io/gh/xi-editor/xi-mac/branch/master/graph/badge.svg)](https://codecov.io/gh/xi-editor/xi-mac)\n\n\u003ch1 align=\"center\"\u003e\n  \u003ca href=\"http://xi-editor.io/xi-editor\"\u003e\u003cimg src=\"icons/xi-editor.png\" alt=\"Xi Editor\" width=\"256\" height=\"256\"/\u003e\u003c/a\u003e\u003cbr\u003e\n  \u003ca href=\"http://xi-editor.io/xi-editor\"\u003eXi Editor\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\u003cem\u003e(pronounced \"Zigh\")\u003c/em\u003e\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003eA modern editor with a backend written in Rust.\u003c/h4\u003e\n\n***Note:*** *This project is still in an early state. Prebuilt binaries will be made available once we start creating versioned releases.*\n\nThe xi-editor project is an attempt to build a high quality text editor,\nusing modern software engineering techniques. This reference frontend is\nbuilt for macOS, using Cocoa for the user interface, but there are work\nin progress frontends for other platforms as well. Consult the\n[list in the xi-editor core README](https://github.com/xi-editor/xi-editor#frontends)\nfor details.\n\nGoals include:\n\n* ***Incredibly high performance***. All editing operations should commit and paint\n  in under 16ms. The editor should never make you wait for anything.\n\n* ***Beauty***. The editor should fit well on a modern desktop, and not look like a\n  throwback from the ’80s or ’90s. Text drawing should be done with the best\n  technology available (Core Text on Mac, DirectWrite on Windows, etc.), and\n  support Unicode fully.\n\n* ***Reliability***. Crashing, hanging, or losing work should never happen.\n\n* ***Developer friendliness***. It should be easy to customize xi editor, whether\n  by adding plug-ins or hacking on the core.\n\nScreenshot (will need to be updated as syntax coloring and UI polish is added):\n\n![xi screenshot](/doc/img/xi-mac-screenshot.png?raw=true)\n\n## Getting started\n\n### Requirements\n\n- [Xcode 10.2](https://developer.apple.com/xcode/)\n- [Rust](https://www.rust-lang.org/). We test against the latest stable version,\nand recommend installing through [rustup](https://rustup.rs).\n\n### Installing\n\n*Note:* the front-end and back-end are split into two separate repositories. This\nis the front-end, and the back-end (or core) is now in\n[xi-editor](https://github.com/xi-editor/xi-editor). It is contained in a submodule that is checked out during the clone command.\n\n**Clone the repository:**\n\n```bash\n\u003e git clone --recurse-submodules https://github.com/xi-editor/xi-mac\n\u003e cd xi-mac\n```\n\n**Build and Open:**\n\n```bash\n\u003e xcodebuild\n\u003e open build/Release/XiEditor.app\n```\n\nOr\n\n```bash\n\u003e open XiEditor.xcodeproj\n```\n\nand then hitting the Run button.\n\n**Move to Applications Folder:**\n\n```bash\n\u003e cp -r Build/Release/XiEditor.app /Applications\n```\n\n### Troubleshooting\n\nThe most common cause of a failed build is an outdated version of `rustc`.\nIf you've installed with rustup, make sure Rust is up to date by running\n`rustup update stable`.\n\n\n## Configuration\n\nUser settings are currently stored in files; the general preferences are\nlocated at `~/Library/Application Support/XiEditor/preferences.xiconfig`.\nThis file can be opened from File \u003e Preferences (⌘ + ,).\n\nThe default font for XiEditor is\n[Inconsolata](http://levien.com/type/myfonts/inconsolata.html), which\nis bundled with the app.\n\n\n### Theme\n\nA few theme files are bundled with the application. A theme can be selected\nfrom the Debug \u003e Theme menu. There is not yet a mechanism for including\ncustom themes.\n\n\n## CLI\n\nXiEditor includes a CLI for opening files directly from the command line.\n\n### Installing\n\n**Through XiEditor:**\n\n1. Install XiEditor\n2. Open XiEditor\n3. XiEditor \u003e Install Command Line Tool\n\n### Usage\n\n```text\nUSAGE: xi [\u003cfiles\u003e ...] [--wait]\n\nARGUMENTS:\n  \u003cfiles\u003e                 Relative or absolute path to the file(s) to open. If none, opens empty editor.\n\nOPTIONS:\n  --wait                  Wait for the editor to close before finishing process.\n  -h, --help              Show help information.\n```\n\n### Git Editor\n\nAdd the following to your `.gitconfig` to use XiEditor as your git editor:\n\n```text\n[core]\n  editor = xi --wait\n```\n\n## Authors\n\nThe xi-editor project was started by Raph Levien but has since received\ncontributions from a number of other people. See the [AUTHORS](AUTHORS)\nfile for details.\n\n\n## License\n\nThis project is licensed under the Apache 2 [license](LICENSE). The bundled fonts are under a\ndifferent license, the Open Font License. See the [fonts](fonts) directory for the fonts and associated\nlicense.\n\n\n## Contributions\n\nWe gladly accept contributions via GitHub pull requests. Please see\n[CONTRIBUTING.md](CONTRIBUTING.md) for more details.\n\nIf you are interested in contributing but not sure where to start, there is an\nactive Zulip channel at #xi-editor on https://xi.zulipchat.com. There is also\na #xi channel on irc.mozilla.org. Finally, there is a subreddit at\n[/r/xi_editor](https://www.reddit.com/r/xi_editor/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxi-editor%2Fxi-mac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxi-editor%2Fxi-mac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxi-editor%2Fxi-mac/lists"}