arbal / brave-control

Control Brave Browser from the command line. List, close, deduplicate and bring focus to open tabs. Also includes Alfred workflow integration.

Home Page:https://github.com/arbal/brave-control

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

About This Fork

Forked from d4rkb1ue/chrome-control to make an equivalent command line utility for Brave Browser. Predicably, it is named brave-control and the script is named brave.js.

Commands used for curious readers:

  1. Modify code & comments. Commit.
perl -pi -e 's/chrome([^\w-])/brave$1/g' ./chrome.js
perl -pi -e 's/Google Chrome/Brave Browser/g' ./chrome.js
perl -pi -e 's/Chrome/Brave/g' ./chrome.js

git add ./chrome.js && git commit -m 'Modified chrome.js to use Brave Browser' && git push

NOTE: In order to preserve history, it is important to commit any file rename operations separately from any file content changes.

  1. Use git-mv to rename script. Commit.
git mv -v ./chrome.js ./brave.js
git commit -m 'Renamed chrome.js to brave.js' && git push
  1. Use hub to rename this repo. Described in github/hub#390.
hub api -XPATCH repos/arbal/chrome-control -f name=brave-control
git remote set-url origin https://github.com/arbal/brave-control.git

Notes from earlier d4rkb1ue/archrome-control fork:

Forked from bit2pixel/chrome-control because the original repo isn't seem to be active any more, with these changes,

  1. Apply performace patch from bit2pixel/chrome-control/pull/7
  2. Disable prompt for "Are you sure" for duplication removal
  3. Search keyword in both title and url
    • for example [Hello World](https://exampledomain.com/hw) can he searched by either hello, world, hw or exampledomain.
  4. New feature to search for bookmarks. Command is b
  5. Change command for Tabs searching to t

How To Install

git clone https://github.com/arbal/brave-control.git
./install.sh

Or just download and double click,

Brave Control

Brave Control

A JXA script and an Alfred Workflow for controlling Brave Browser (Javascript for Automation). Also see my How I Navigate Hundreds of Tabs on Chrome with JXA and Alfred article if you're interested in learning how I created the workflow.

Usage

Make this file an executable

chmod +x ./brave.js

Then run:

./brave.js

MacOS will ask you to allow permissions for this tool to control Brave. Feel free to inspect the code before accepting.

Integration

You can use brave-control to create fun integrations with your favorite tools (Alfred, vim, vscode, iterm2, ...).

Alfred

I've created an Alfred Workflow to use Brave Control. You can find it under the intergrations directory.

Alfred Brave Control commands:

  • tabs: Lists all tabs
  • close url <keywords>: Close tabs with URLs matching these keywords
  • close title <keywords>: Close tabs with titles matching these keywords
  • dedup: Close duplicate tabs

Alfred

Commands

Close duplicate tabs

./brave.js dedup

Close all tabs by titles containing strings

Strings are separated by spaces and case insensitive.

./brave.js close --title "inbox" "iphone - apple"
./brave.js close --title inbox iphone

Close all tabs by URLs containing strings

Strings are separated by spaces and case insensitive.

./brave.js close --url "mail.google" "apple"
./brave.js close --url google apple

List all open tabs in all Brave windows

./brave.js list

The output is JSON, so you can pipe it to jq.

./brave.js list | jq .

Returns a struct like this:

{
  "items": [
    {
      "title": "Inbox (1) - <hidden>@gmail.com - Gmail",
      "url": "https://mail.google.com/mail/u/0/#inbox",
      "winIdx": 0,
      "tabIdx": 0,
      "arg": "0,0",
      "subtitle": "https://mail.google.com/mail/u/0/#inbox"
    },
    {
      "title": "iPhone - Apple",
      "url": "https://www.apple.com/iphone/",
      "winIdx": 0,
      "tabIdx": 1,
      "arg": "0,1",
      "subtitle": "https://www.apple.com/iphone/"
    }
  ]
}

arg and subtitle are used for Alfred integration.

Close a specific tab in a specific window

Window Index and Tab Index is the arg returned by the list command.

./brave.js close 0,13

Focus on a specific tab in a specific window

./brave.js focus 0,13

Show help

./brave.js

Don't prompt the user

--yes flag will cause no questions to be asked to the user. It'll close all tabs straight away.

Attention: Use this with caution. Make sure you don't have any unsaved work, emails, ... etc.

Prompt user in Brave

--ui flag will cause the questions to be asked using a Brave dialog instead of text in command line.

./brave.js close --url apple --ui

Dialog

How did you create the banner and icon?

It took around 4 hours using Photoshop. I wanted to use Illustrator but I realized that I completely forgot how to use it.

Drawing the shapes are pretty easy but I spent most of the time on the following:

  • Picking harmonious colors.
  • Figuring out how to make it less dull, ended up using a shadow under the window which made a significant difference.
  • Figuring out how to represent the infrared waves.
  • Finding a way to export the PNG to ICNS.

Planning to write an article on that soon.

Bug Fixes & Pull Requests

If you find any bugs please feel to create an issue or create a pull request.

I can only accept pull requests to the source code and not the binary files for ensuring the repo stays sanitized. If you have any feature requests for the workflow, I'd be happy to add them in after a discussion.

License

Copyright (c) 2019 Renan Cakirerk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Control Brave Browser from the command line. List, close, deduplicate and bring focus to open tabs. Also includes Alfred workflow integration.

https://github.com/arbal/brave-control

License:MIT License


Languages

Language:JavaScript 98.0%Language:Shell 2.0%