{"id":13477179,"url":"https://github.com/ChrisPenner/btt-quicknav","last_synced_at":"2025-03-27T04:32:48.302Z","repository":{"id":77071316,"uuid":"131683658","full_name":"ChrisPenner/btt-quicknav","owner":"ChrisPenner","description":"HTML overlay for quickly navigating your computer","archived":false,"fork":false,"pushed_at":"2018-06-03T18:11:04.000Z","size":5021,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-01T16:47:43.569Z","etag":null,"topics":["bettertouchtool","workflow"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ChrisPenner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-05-01T06:31:28.000Z","updated_at":"2024-01-06T14:21:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"2c32463c-b734-421a-83bb-fe0300eb2c21","html_url":"https://github.com/ChrisPenner/btt-quicknav","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/ChrisPenner%2Fbtt-quicknav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisPenner%2Fbtt-quicknav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisPenner%2Fbtt-quicknav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChrisPenner%2Fbtt-quicknav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChrisPenner","download_url":"https://codeload.github.com/ChrisPenner/btt-quicknav/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222194765,"owners_count":16946983,"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":["bettertouchtool","workflow"],"created_at":"2024-07-31T16:01:39.111Z","updated_at":"2025-03-27T04:32:48.296Z","avatar_url":"https://github.com/ChrisPenner.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"Better Touch Tool Quick-navigator\n=================================\n\n**NOTE**: Requires latest alpha of [Better Touch Tool](https://folivora.ai/)\n\nA quick navigator to automate your workflow;\n\nCurrently has commands to help you:\n\n- Jump to bookmarks\n- Open browser sessions (or presets)\n- Open slack channels\n- Run bash commands\n\n![quicknav demo](./images/quicknav.gif)\n\n## Installation\n\n- `git clone https://github.com/ChrisPenner/btt-quicknav.git`\n- `cd btt-quicknav`\n- `npm install`\n\n## Setup\n\nIn order to use quick-nav you'll need to set it up with whatever commands or configuration you like.\nEdit `src/config.js` to configure any commands you like!\n\n\\*\\* NOTE \\*\\* the default `src/config.js` is configured to show off how\ncertain commands work, but certain commands (e.g. pivotal, slack, project) won't work properly until you\nconfigure them for your computer, or set YOUR API tokens/IDs in place.\n\n\n## Running\n\n- `npm run build`: You'll need to set up your config files for this to succeed\n- Add a new html overlay on some keyboard shortcut inside BTT\n\nBasic settings:\n![basic settings](./images/settings-basic.png)\n\nAdvanced settings:\n![advanced settings](./images/settings-advanced.png)\n\n## Writing your own commands\n\nWriting your own commands is easy! A command is simply a javascript object with the following fields; OR a javascript\nPromise that resolves to an object with these fields (for doing API calls as part of your command)\n\n```javascript\n{\n    title: 'My Command'\n    options: [{\n        label: \"My first option's label\",\n        value: \"some-value\"\n    }],\n    onSelect: ({label, value}) =\u003e {\n        // Here you can do whatever you want when someone selects an option\n        console.log('you ran the command with a label and value of:', label, value);\n    },\n}\n```\n\nI've already written a few helpers; see `src/commands/web-link-command.js` for a simple 'open browser' command, or\n`src/commands/bash-command.js` for a command which helps you run bash commands on your computer. Each of these expose a\nfunction which accepts an object with a `title` and `options` and build the appropriate command for you. Add each\ncommand to your `src/command-config.js` and then `npm run build` for your new commands to show up.\n\nSee `config.js` for examples!\n\n## Troubleshooting\n\nIf nothing shows up when you hit your shortcut, it's possible the javascript has crashed. Try right-clicking where the\noverlay should be and see if you get an option to `Inspect Element`; this will help you see what's going on. You can\nalso open the `build/index.html` in any normal browser to see what's happening.\n\nA common mistake is to forget that BTT caches the overlay and \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChrisPenner%2Fbtt-quicknav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FChrisPenner%2Fbtt-quicknav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChrisPenner%2Fbtt-quicknav/lists"}