Skip to content

wajeht/bang

demo.mov

Bang

Node.js CI License: MIT Open Source Love svg1

your personal command center for blazingly fast web navigation

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
  • @t, @tab, @tabs - Access your tabs
  • @n, @note, @notes - Access your notes
  • @a, @action, @actions - Access your actions
  • @bm, @bookmark, @bookmarks - Access your bookmarks
  • @r, @reminders - Access your reminders

Special Commands

  • @bm [search term] - Search your bookmarks
  • @a [search term] - Search your actions
  • @n [search term] - Search your notes
  • @r [search term] - Search your reminders
  • !find [search term] - Global search across all resources (bookmarks, actions, notes, tabs, reminders)
  • !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
  • !bm --hide [url] - Add a hidden bookmark (requires global password)
  • !bm --hide [title] [url] - Add a hidden bookmark with title
    • --hide flag makes the bookmark hidden (only visible after password verification)
    • Requires global password to be set in settings
    • eg: !bm --hide https://private-site.com
    • eg: !bm --hide Private Site https://private-site.com
  • !add [trigger] [url] - Create a custom bang
    • [trigger] is required
    • [url] is required
    • eg: !add jaw https://bang.jaw.dev
  • !add --hide [trigger] [url] - Create a hidden custom bang (requires global password)
    • --hide flag makes the action hidden (only visible after password verification)
    • Only redirect-type actions can be hidden
    • Requires global password to be set in settings
    • eg: !add --hide private https://private-service.com
  • !del [trigger] - Delete a custom bang or tab
    • [trigger] is required (the bang/tab trigger to delete)
    • Works with both bangs and tabs - will delete from both if they exist
    • eg: !del jaw or !del !jaw
  • !edit [trigger] [new-trigger] - Change a bang's or tab's trigger
    • [trigger] is required (the current bang/tab trigger)
    • [new-trigger] is required (the new trigger name)
    • Works with both bangs and tabs - will update whichever exists
    • eg: !edit jaw !newjaw
  • !edit [trigger] [url] - Change a bang's URL
    • [trigger] is required (the bang trigger to edit)
    • [url] is required (the new URL)
    • Note: URL editing only applies to bangs, not tabs
    • eg: !edit jaw https://new-url.com
  • !edit [trigger] [new-trigger] [url] - Change both trigger and URL
    • [trigger] is required (the current bang trigger)
    • [new-trigger] is required (the new trigger name)
    • [url] is required (the new URL)
    • Note: URL editing only applies to bangs, not tabs
    • eg: !edit jaw !newjaw https://new-url.com
  • !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
  • !note --hide [title] | [content] - Create a hidden note (requires global password)
    • --hide flag makes the note hidden (only visible after password verification)
    • Requires global password to be set in settings
    • eg: !note --hide Private Note | sensitive information here
    • eg: !note --hide this is hidden content without title
  • !remind [description] - Create a reminder with your default timing
    • [description] is required (what you want to be reminded about)
    • Uses your default reminder timing preference (set in /reminders settings)
    • eg: !remind take out trash
    • eg: !remind check email
  • !remind [when] [description] - Create a reminder with timing keyword
    • [when] is required (daily, weekly, biweekly, monthly, or YYYY-MM-DD)
    • [description] is required (what you want to be reminded about)
    • eg: !remind daily google.com
    • eg: !remind weekly water plants
  • !remind [when] | [description] [| [content]] - Create a reminder with specific timing
    • [when] is required (daily, weekly, biweekly, monthly, or YYYY-MM-DD)
    • [description] is required (what you want to be reminded about)
    • [content] is optional (URL or any additional text/notes)
    • eg: !remind daily | take vitamins
    • eg: !remind weekly | water plants
    • eg: !remind 2025-02-15 | valentine's day
    • eg: !remind monthly | pay bills | https://bank.com

Docs

License

Distributed under the MIT License © wajeht. See LICENSE for more information.

About

your personal command center for blazingly fast web navigation

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages