https://github.com/wajeht/bang

DuckDuckGo's !Bangs, but on steroids.
https://github.com/wajeht/bang

bang bookmarks cross-platform duckduckgo golang search shortcut sync vue

Last synced: about 21 hours ago
JSON representation

DuckDuckGo's !Bangs, but on steroids.

• Host: GitHub
• URL: https://github.com/wajeht/bang
• Owner: wajeht
• License: mit
• Created: 2023-07-08T22:00:32.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-14T22:20:30.000Z (3 months ago)
• Last Synced: 2025-02-14T23:24:15.518Z (3 months ago)
• Topics: bang, bookmarks, cross-platform, duckduckgo, golang, search, shortcut, sync, vue
• Language: TypeScript
• Homepage: https://bang.jaw.dev/
• Size: 39.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Roadmap: docs/roadmap.md

Awesome Lists containing this project

README

        
https://github.com/user-attachments/assets/5f033de3-afa1-44a7-b55b-dc45fc203d10

# ❗️Bang

[![Node.js CI](https://github.com/wajeht/bang/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/wajeht/bang/actions/workflows/ci.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/wajeht/bang)

DuckDuckGo's !Bangs, but on steroids.

## 📖 Usage

### 🔍 Setup Custom Search Engine in Your Browser

Before you can use the Bang command from your browser's search bar, you need to add the Bang URL as a custom search engine. Follow these steps:

1. In your browser settings, add a new search engine:

    - **Name**: Whatever you prefer (e.g., "Bang")

    - **Shortcut**: `bd` (or any keyword you prefer)

    - **URL**: `http://bang.jaw.dev/?q=%s`

2. Now you can use Bang directly from your browser's address bar:

    ```

    !bm https://bang.jaw.dev

    ```

### ⚙️ How to Add Custom Search Engine

- **Chrome**: Settings → Search Engines → Manage Search Engines → Add

- **Firefox**: Bookmarks → Manage Bookmarks → Right-click → New Bookmark → Add %s in URL

- **Edge**: Settings → Privacy, search, and services → Address bar and search → Manage search engines → Add

### 🎯 Default Commands

- `@data` - Access data

- `@admin` - Access admin

- `@api` - Access API docs

- `@b`, `@bangs` - Go to home page

- `@s`, `@settings` - Access settings

- `@n`, `@note`, `@notes` - Access your notes

- `@a`, `@action`, `@actions` - Access your actions

- `@bm`, `@bookmark`, `@bookmarks` - Access your bookmarks

### 🎨 Special Commands

- `@bm [search term]` - Search your bookmarks

- `@a [search term]` - Search your actions

- `@n [search term]` - Search your notes

- `!bm [url]` - Add a bookmark

- `!bm [title] [url]` - Add a bookmark

    - `[title]` is optional, if not provided, we will auto fetch the title

    - `[url]` is required

    - eg: `!bm this title can be super long https://bang.jaw.dev`

- `!add [trigger] [url]` - Create a custom bang

    - `[trigger]` is required

    - `[url]` is required

    - eg: `!add jaw https://bang.jaw.dev`

- `!note [title] | [content]` - Create a note

    - `[title]` is optional, if not provided, we will use it as `Untitled`

    - `[content]` is required

    - eg: `!note some title | this is a note https://bang.jaw.dev`

    - eg: `!note this is a content without any title`

## 📑 Docs

- See [RECIPE](./docs/recipe.md) for `recipe` guide.

- See [DEVELOPMENT](./docs/development.md) for `development` guide.

- See [CONTRIBUTION](./docs/contribution.md) for `contribution` guide.

## 📜 License

Distributed under the MIT License © [wajeht](https://github.com/wajeht). See [LICENSE](./LICENSE) for more information.