https://github.com/frenchbread/k

Last synced: about 1 month ago
JSON representation

CLI stuff launcher

Host: GitHub
URL: https://github.com/frenchbread/k
Owner: frenchbread
License: mit
Created: 2022-09-13T16:36:11.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-12-21T14:41:31.000Z (over 2 years ago)
Last Synced: 2025-03-13T23:46:24.725Z (2 months ago)
Language: TypeScript
Size: 244 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

README

### kl1

> CLI items launcher

- macOs apps
- run shell commands (aka `alias`)
- open urls (aka `bookmarks`)

### ⚙️ setup

```sh
# install
❯ npm i kl1 -g

# run
❯ kl1
```

You can alias it into something shorter e.g. `k`. Or add a workflow (e.g. keybind) that starts terminal sesh (window) with this command.

#### 📔 adding items

Adding is done by selecting `+ add` option and filling out prompt fields:

- type
- `app` (only `macOs` currently supported)
- select app
- `cli command`
- shell script
- `href`
- url
- name

#### 🗑️ removing items

Removing items is done by selecting `- remove` option and multi-selecting items from the list.

#### 🚀 main screen

```
- items[]
- _id
- name
- type [cli_command run, app launch, browser link]
- + add
- - remove
```

### 🛠️ development

**clone the repo**

```sh
❯ git clone https://github.com/frenchbread/k.git && cd k
```

**install dependencies**

```sh
❯ npm i
```

**start**

```sh
❯ npm run start
```

**build**

```sh
❯ npm run build
```

### License

[MIT](https://github.com/frenchbread/k/blob/main/LICENSE)