{"id":18837071,"url":"https://github.com/bkuhlmann/sublime_text_kit","last_synced_at":"2025-10-08T22:04:58.495Z","repository":{"id":13608826,"uuid":"16301820","full_name":"bkuhlmann/sublime_text_kit","owner":"bkuhlmann","description":"A command line interface for managing Sublime Text metadata.","archived":false,"fork":false,"pushed_at":"2025-10-08T01:14:24.000Z","size":1021,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-08T07:22:23.393Z","etag":null,"topics":["cli","project-management","sublime-text"],"latest_commit_sha":null,"homepage":"https://alchemists.io/projects/sublime_text_kit","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bkuhlmann.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.adoc","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["bkuhlmann"]}},"created_at":"2014-01-28T04:10:10.000Z","updated_at":"2025-10-08T01:14:28.000Z","dependencies_parsed_at":"2023-02-19T00:55:17.099Z","dependency_job_id":"aac89c2c-9591-43fe-9585-49d242ded1ed","html_url":"https://github.com/bkuhlmann/sublime_text_kit","commit_stats":{"total_commits":723,"total_committers":2,"mean_commits":361.5,"dds":"0.11065006915629327","last_synced_commit":"f55ad64c9c8bcd69634fea7c55246680baa5e863"},"previous_names":[],"tags_count":108,"template":false,"template_full_name":null,"purl":"pkg:github/bkuhlmann/sublime_text_kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhlmann%2Fsublime_text_kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhlmann%2Fsublime_text_kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhlmann%2Fsublime_text_kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhlmann%2Fsublime_text_kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bkuhlmann","download_url":"https://codeload.github.com/bkuhlmann/sublime_text_kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bkuhlmann%2Fsublime_text_kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000684,"owners_count":26082837,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cli","project-management","sublime-text"],"created_at":"2024-11-08T02:33:43.648Z","updated_at":"2025-10-08T22:04:58.481Z","avatar_url":"https://github.com/bkuhlmann.png","language":"Ruby","funding_links":["https://github.com/sponsors/bkuhlmann"],"categories":[],"sub_categories":[],"readme":":toc: macro\n:toclevels: 5\n:figure-caption!:\n\n= Sublime Text Kit\n\nSublime Text Kit is a command line interface for managing Sublime Text metadata for multiple\nprojects, sessions, snippets, etc. This allows you to avoiding manual maintenance of your workspace\nso you can stay focused on your own work.\n\ntoc::[]\n\n== Features\n\n* Manages project metadata (`.sublime-project` and `.sublime-workspace` files).\n* Manages session metadata so you can quickly toggle between projects via the `CONTROL+COMMAND+p`\n  shortcut.\n* Prints all of your custom snippets in either link:https://asciidoctor.org[ASCII Doc] or\n  link:https://daringfireball.net/projects/markdown[Markdown] format.\n\n== Requirements\n\n. link:https://www.ruby-lang.org[Ruby]\n. link:https://www.sublimetext.com[Sublime Text]\n\n== Setup\n\nTo install _with_ security, run:\n\n[source,bash]\n----\n# 💡 Skip this line if you already have the public certificate installed.\ngem cert --add \u003c(curl --compressed --location https://alchemists.io/gems.pem)\ngem install sublime_text_kit --trust-policy HighSecurity\n----\n\nTo install _without_ security, run:\n\n[source,bash]\n----\ngem install sublime_text_kit\n----\n\n== Usage\n\n=== Command Line Interface (CLI)\n\nFrom the command line, type: `sublime_text_kit`\n\nimage:https://alchemists.io/images/projects/sublime_text_kit/screenshots/usage.png[Usage,width=773,height=413,role=focal_point]\n\n=== Customization\n\nThis gem can be configured via a global configuration:\n`~/.config/sublime_text_kit/configuration.yml`. It can also be configured via\nlink:https://alchemists.io/projects/xdg[XDG] environment variables.\n\nAn example configuration could be:\n\n[source,yaml]\n----\nproject_roots:\n  - \"~/Engineering/Organizations\"\n  - \"~/Engineering/OSS\"\nmetadata_dir: \"~/Dropbox/Cache/Sublime\"\nsnippets_format: :markdown\n----\n\nThe `project_roots` key defines the root level directories where your project folders are located.\nWhen project metadata (i.e. `.sublime-project`, `.sublime-workspace`) is generated, the name of the\nmetadata file will be the same name as the project folder. All project metadata, regardless of root\nlocation, is written to the same metadata directory as defined by the `metadata_dir` key. If using\nthe example settings shown above and assuming the following directory structure exists…\n\n....\n~/Engineering/OSS/example\n~/Engineering/OSS/sublime_text_kit\n....\n\n...project metadata will be created in the `metadata_dir` as follows:\n\n....\n~/Dropbox/Cache/Sublime/example.sublime-project\n~/Dropbox/Cache/Sublime/example.sublime-workspace\n~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-project\n~/Dropbox/Cache/Sublime/sublime_text_kit.sublime-workspace\n....\n\nThe `snippets_format` key allows you define what format to print your snippets as. You can always\noverride your default configuration by specifying the format from the command line:\n`sublime_text_kit -s ascii_doc`. For example, this is how\nlink:https://alchemists.io/projects/sublime_text_setup/#_snippets[snippets documentation] is\ngenerated for the link:https://alchemists.io/projects/sublime_text_setup[Sublime Text Setup]\nproject.\n\n=== Workflow\n\nThe following demonstrates a default Sublime Text setup:\n\n1. Start by defining your configuration: `sublime_text_kit --config edit`.\n2. Shutdown Sublime Text (i.e. `COMMAND+q`).\n3. Run `sublime_text_kit --update` which will create project metadata and rebuild session metadata\n   so Sublime Text has a complete project history from which to switch between via the\n   `CONTROL+COMMAND+p` shortcut.\n4. Launch Sublime Text and use the `CONTROL+COMMAND+p` keyboard shortcut to toggle between projects.\n   Notice that you can (fuzzy type) project names to jump between them.\n5. Navigate through your project workload with ease. 🎉\n\n=== Troubleshooting\n\n* When rebuilding your session, ensure Sublime Text is shut down or changes might not be applied\n  properly.\n* When rebuilding project metadata, ensure the `metadata_dir` -- as defined via your configuration\n  -- points to an existing directory which can contain `.sublime-project` and `.sublime-workspace`\n  files.\n\n== Development\n\nTo contribute, run:\n\n[source,bash]\n----\ngit clone https://github.com/bkuhlmann/sublime_text_kit\ncd sublime_text_kit\nbin/setup\n----\n\nYou can also use the IRB console for direct access to all objects:\n\n[source,bash]\n----\nbin/console\n----\n\n== Tests\n\nTo test, run:\n\n[source,bash]\n----\nbin/rake\n----\n\n== link:https://alchemists.io/policies/license[License]\n\n== link:https://alchemists.io/policies/security[Security]\n\n== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]\n\n== link:https://alchemists.io/policies/contributions[Contributions]\n\n== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]\n\n== link:https://alchemists.io/projects/sublime_text_kit/versions[Versions]\n\n== link:https://alchemists.io/community[Community]\n\n== Credits\n\n* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].\n* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkuhlmann%2Fsublime_text_kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbkuhlmann%2Fsublime_text_kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbkuhlmann%2Fsublime_text_kit/lists"}