Set autocmds to run when certain events happen.
Curently, only 'TriStart' and 'DocStart' are supported.
For DocStart: a fragment of the URL on which the events will trigger, or a JavaScript regex (e.g, /www\.amazon\.co.*\/
)
We just use URL.search.
For TriStart: A regular expression that matches the hostname of the computer the autocmd should be run on. This requires the native messenger to be installed, except for the ".*" regular expression which will always be triggered, even without the native messenger.
The excmd to run (use composite to run multiple commands)
Navigate back one page in history.
Bind a sequence of keys to an excmd or view bound sequence.
This is an easier-to-implement bodge while we work on vim-style maps.
Examples:
bind G fillcmdline tabopen google
bind D composite tabclose | buffer #
bind j scrollline 20
bind F hint -b
You can view binds by omitting the command line:
bind j
bind k
You can bind to modifiers and special keys by enclosing them with angle brackets, for example bind <C-\>z fullscreen
, unbind <F1>
(a favourite of people who use TreeStyleTabs :) ), or bind <Backspace> forward
.
Modifiers are truncated to a single character, so Ctrl -> C, Alt -> A, and Shift -> S. Shift is a bit special as it is only required if Shift does not change the key inputted, e.g. <S-ArrowDown>
is OK, but <S-a>
should just be A
.
You can view all special key names here: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
Use composite if you want to execute multiple excmds. Use fillcmdline to put a string in the cmdline and focus the cmdline (otherwise the string is executed immediately).
See also:
Add or remove a bookmark.
Optionally, you may give the bookmark a title. If no URL is given, a bookmark is added for the current page.
If a bookmark already exists for the URL, it is removed, even if a title is given.
Does not support creation of folders: you'll need to use the Firefox menus for that.
Title for the bookmark (can include spaces but not forward slashes, as these are interpreted as folders). If you want to put the bookmark in a folder, you can:
/Bookmarks Menu/Mozilla Firefox/My New Bookmark Title
Firefox/My New Bookmark Title
Firefox/
Change active tab.
Starts at 1. 0 refers to last tab, -1 to penultimate tab, etc.
"#" means the tab that was last accessed in this window
Focus the tab which contains the last focussed input element. If you're lucky, it will focus the right input, too.
Currently just goes to the last focussed input; being able to jump forwards and backwards is planned.
Use the system clipboard.
If excmd == "open"
, call open with the contents of the clipboard. Similarly for tabopen.
If excmd == "yank"
, copy the current URL, or if given, the value of toYank, into the system clipboard.
If excmd == "yankcanon"
, copy the canonical URL of the current page if it exists, otherwise copy the current URL.
If excmd == "yankshort"
, copy the shortlink version of the current URL, and fall back to the canonical then actual URL. Known to work on https://yankshort.neocities.org/.
If excmd == "yanktitle"
, copy the title of the open page.
If excmd == "yankmd"
, copy the title and url of the open page formatted in Markdown for easy use on sites such as reddit.
Unfortunately, javascript can only give us the clipboard
clipboard, not e.g. the X selection clipboard.
Similar to vim's comclear
command. Clears an excmd alias defined by
command
.
For example: comclear helloworld
will reverse any changes caused
by command helloworld xxx
See also:
Similar to vim's :command
. Maps one ex-mode command to another.
If command already exists, this will override it, and any new commands
added in a future release will be SILENTLY overridden. Aliases are
expanded recursively.
Examples:
command t tabopen
command tn tabnext_gt
= command hello t
This will expand recursively into 'hello'->'tabopen'Note that this is only for excmd->excmd mappings. To map a normal-mode command to an excommand, see bind.
See also:
Split cmds
on pipes (|) and treat each as its own command. Return values are cast to strings and passed to the appended to the arguments of the next ex command, e.g,
composite echo yes | fillcmdline
becomes fillcmdline yes
. A more complicated example is the ex alias, command current_url composite get_current_url | fillcmdline_notrail
, which is used in, e.g. bind T current_url tabopen
.
Workaround: this should clearly be in the parser, but we haven't come up with a good way to deal with |s in URLs, search terms, etc. yet.
cmds
are also split with semicolons (;) and don't pass things along to each other.
The behaviour of combining ; and | in the same composite command is left as an exercise for the reader.
Display Tridactyl's contributors in order of commits in a user-friendly fashion
Opens your favourite editor (which is currently gVim) and fills the last used input with whatever you write into that file. Requires that the native messenger is installed, see native and installnative.
Uses the editorcmd
config option, default = auto
looks through a list defined in native_background.ts try find a sensible combination. If it's a bit slow, or chooses the wrong editor, or gives up completely, set editorcmd to something you want. The command must stay in the foreground until the editor exits.
The editorcmd needs to accept a filename, stay in the foreground while it's edited, save the file and exit.
You're probably better off using the default insert mode bind of
Run command in /bin/sh (unless you're on Windows), and print the output in the command line. Non-zero exit codes and stderr are ignored, currently.
Requires the native messenger, obviously.
If you want to use a different shell, just prepend your command with whatever the invocation is and keep in mode that most shells require quotes around the command to be executed, e.g. :exclaim xonsh -c "1+2"
.
Aliased to !
but the exclamation mark must be followed with a space.
Like exclaim, but without any output to the command line.
Set the current value of the commandline to string with a trailing space
Set the current value of the commandline to string without a trailing space
Fills the last used input box with content. You probably don't want this; it's used internally for editor.
That said, bind gs fillinput [Tridactyl](https://addons.mozilla.org/en-US/firefox/addon/tridactyl-vim/) is my favourite add-on
could probably come in handy.
Start find mode. Work in progress.
the direction to search in: 1 is forwards, -1 is backwards.
Highlight the next occurence of the previously searched for word.
Simply sets
"privacy.resistFingerprinting.block_mozAddonManager":true
"extensions.webextensions.restrictedDomains":""
in about:config via user.js so that Tridactyl (and other extensions!) can be used on addons.mozilla.org and other sites.
Requires native
.
Focus the last used input on the page
focus the nth input on the page, or "special" inputs: "-l": last focussed input "-n": input after last focussed one "-N": input before last focussed one "-p": first password field "-b": biggest input field
Find a likely next/previous link and follow it
If a link or anchor element with rel=rel exists, use that, otherwise fall back to:
1) find the last anchor on the page with innerText matching the appropriate followpagepattern
.
2) call urlincrement with 1 or -1
If you want to support e.g. French:
set followpagepatterns.next ^(next|newer|prochain)\b|»|>>
set followpagepatterns.prev ^(prev(ious)?|older|précédent)\b|»|>>
the relation of the target page to the current page: "next" or "prev"
Navigate forward one page in history.
Toggle fullscreen state
Puts the contents of config value with keys keys
into the commandline and the background page console
It's a bit rubbish, but we don't have a good way to provide feedback to the commandline yet.
You can view the log entry in the browser console (Ctrl-Shift-j).
For example, you might try get nmaps
to see all of your current binds.
Returns the current URL. For use with composite.
Initialize gobble mode.
It will read nChars
input keys, append them to endCmd
and execute that
string.
Change which parts of the Firefox user interface are shown. NB: This feature is experimental and might break stuff.
Might mangle your userChrome. Requires native messenger, and you must restart Firefox each time to see any changes (this can be done using restart).
View available rules and options here and here.
Example usage: guiset gui none
, guiset gui full
, guiset tabs autohide
.
Some of the available options:
gui
tabs
navbar
hoverlink (the little link that appears when you hover over a link)
titlebar
Show this page.
:help <excmd>
jumps to the entry for that command.
e.g. :help bind
Hint a page.
bind ;c hint -c [class*="expand"],[class="togg"]
works particularly well on reddit and HN-W excmd...
append hint href to excmd and execute, e.g, hint -W exclaim mpv
to open YouTube videosExcepting the custom selector mode and background hint mode, each of these
hint modes is available by default as ;<option character>
, so e.g. ;y
to yank a link's target.
To open a hint in the background, the default bind is F
.
Related settings: "hintchars": "hjklasdfgyuiopqwertnmzxcvb" "hintfiltermode": "simple" | "vimperator" | "vimperator-reflow" "relatedopenpos": "related" | "next" | "last"
Go to your homepage(s)
Simply copies "curl -fsSl https://raw.githubusercontent.com/cmcaine/tridactyl/master/native/install.sh | bash" to the clipboard and tells the user to run it.
Lets you execute JavaScript in the page context. If you want to get the result back, use composite js ... | fillcmdline
Some of Tridactyl's functions are accessible here via the tri
object. Just do console.log(tri)
in the web console on the new tab page to see what's available.
Aliased to !js
Lets you execute JavaScript in the background context. All the help from js applies. Gives you a different tri
object.
Set the logging level for a given logging module.
the logging module to set the level on
the level to log at: in increasing verbosity, one of "never", "error", "warning", "info", "debug"
Example:
mode ignore
to ignore all keys.Tells you if the native messenger is installed and its version.
Uses the native messenger to open URLs.
Be seriously careful with this: you can use it to open any URL you can open in the Firefox address bar.
You've been warned.
Unsupported on OSX unless you set browser
to something that will open Firefox from a terminal pass it commmand line options.
Open a new page in the current tab.
@param urlarr
- if first word looks like it has a schema, treat as a URI
- else if the first word contains a dot, treat as a domain name
- else if the first word is a key of [[SEARCH_URLS]], treat all following terms as search parameters for that provider
- else treat as search parameters for google
Related settings:
"searchengine": "google" or any of [[SEARCH_URLS]]
"historyresults": the n-most-recent results to ask Firefox for before they are sorted by frequency. Reduce this number if you find your results are bad.
Can only open about: or file: URLs if you have the native messenger installed, and on OSX you must set browser
to something that will open Firefox from a terminal pass it commmand line options.
Pin the current tab
Close all windows
Opens the current page in Firefox's reader mode. You currently cannot use Tridactyl while in reader mode.
Tries to find a node which can be scrolled either x pixels to the right or y pixels down among the Elements in {nodes} and children of these Elements.
This function used to be recursive but isn't anymore due to various attempts at optimizing the function in order to reduce GC pressure.
Reload the next n tabs, starting with activeTab, possibly bypassingCache
Reloads all tabs, bypassing the cache if hard is set to true
Reload the next n tabs, starting with activeTab. bypass cache for all
Repeats a cmd
n
times.
Falls back to the last executed command if cmd
doesn't exist.
Executes the command once if n
isn't defined either.
Restarts firefox with the same commandline arguments.
Warning: This can kill your tabs, especially if you :restart several times in a row
Deletes various privacy-related items.
The list of possible arguments can be found here: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/browsingData/DataTypeSet
Additional, tridactyl-specific arguments are:
Timespan parameter: -t [0-9]+(m|h|d|w)
Examples:
sanitise all
-> Deletes everythingsanitise history
-> Deletes all historysanitise commandline tridactyllocal tridactylsync
-> Deletes every bit of data Tridactyl holdssanitise cookies -t 3d
-> Deletes cookies that were set during the last three days.If two numbers are given, treat as x and y values to give to window.scrollTo If one number is given, scroll to that percentage along a chosen axis, defaulting to the y-axis
Set a search engine keyword for use with *open or set searchengine
the keyword to use for this search (e.g. 'esa')
the URL to interpolate the query into. If %s is found in the URL, the query is inserted there, else it is appended. If the insertion point is in the "query string" of the URL, the query is percent-encoded, else it is verbatim.
Set a key value pair in config.
Use to set any string values found here
e.g. set searchurls.google https://www.google.com/search?q= set logging.messaging info
Runs an RC file from disk.
If no argument given, it will try to open ~/.tridactylrc, ~/.config/tridactylrc or $XDG_CONFIG_HOME/tridactyl/tridactylrc in reverse order.
The RC file is just a bunch of Tridactyl excmds (i.e, the stuff on this help page). Settings persist in local storage; add sanitise tridactyllocal tridactylsync
to make it more Vim like. There's an example file if you want it.
the file to open. Must be an absolute path, but can contain environment variables and things like ~.
Same as source but suppresses all errors
Close a tab.
Known bug: autocompletion will make it impossible to close more than one tab at once if the list of numbers looks enough like an open tab's title or URL.
The 1-based indexes of the tabs to target. indexes < 1 wrap. If omitted, this tab.
Close all tabs to the left of the current one
Close all tabs to the right of the current one
Detach a tab, opening it in a new window.
The 1-based index of the tab to target. index < 1 wraps. If omitted, this tab.
Duplicate a tab.
The 1-based index of the tab to target. index < 1 wraps. If omitted, this tab.
Switch to the first tab.
Switch to the last tab.
Move the current tab to be just in front of the index specified.
Known bug: This supports relative movement, but autocomple doesn't know that yet and will override positive and negative indexes.
Put a space in front of tabmove if you want to disable completion and have the relative indexes at the command line.
Binds are unaffected.
New index for the current tab.
1 is the first index. 0 is the last index. -1 is the penultimate, etc.
Switch to the next tab, wrapping round.
If increment is specified, move that many tabs forwards.
Switch to the next tab, wrapping round.
If an index is specified, go to the tab with that number (this mimics the
behaviour of {count}gt
in vim, except that this command will accept a
count that is out of bounds (and will mod it so that it is within bounds as
per tabmove, etc)).
Close all other tabs in this window
Like open, but in a new tab. If no address is given, it will open the newtab page, which can be set with set newtab [url]
Use the -b
flag as the first argument to open the tab in the background.
Unlike Firefox's Ctrl-t shortcut, this opens tabs immediately after the currently active tab rather than at the end of the tab list because that is the authors' preference.
If you would rather the Firefox behaviour set tabopenpos last
. This
preference also affects the clipboard, quickmarks, home, help, etc.
If you would rather the URL be opened as if you'd middle clicked it, set
tabopenpos related
.
Hinting is controlled by relatedopenpos
Switch to the previous tab, wrapping round.
If increment is specified, move that many tabs backwards.
Read text content of elements matching the given selector
the selector to match elements
Cancel current reading and clear pending queue
Arguments:
Read the given text using the browser's text to speech functionality and the settings currently set
the command mode -t read the following args as text -c read the content of elements matching the selector
Show a list of the voices available to the TTS system. These can be
set in the config using ttsvoice
Start the tutorial
whether to start the tutorial in a newtab. Defaults to current tab.
restore most recently closed tab in this window unless the most recently closed item was a window
Blur (unfocus) the active element
Updates the native messenger if it is installed, using our GitHub repo. This is run every time Tridactyl is updated.
If you want to disable this, or point it to your own native messenger, edit the nativeinstallcmd
setting.
Increment the current tab URL
the increment step, can be positive or negative
Open a URL made by modifying the current URL
There are several modes:
Text replace mode: urlmodify -t <old> <new>
Replaces the first instance of the text old
with new
.
http://example.com
-> (-t exa peta
) -> http://petample.com
Regex replacment mode: urlmodify -r <regexp> <new> [flags]
Replaces the first match of the regexp
with new
. You can use
flags i
and g
to match case-insensitively and to match
all instances respectively
http://example.com
-> (-r [ea] X g
) -> http://XxXmplX.com
Query replace mode: urlmodify -q <query> <new_val>
Replace the value of a query with a new one:
http://e.com?id=foo
-> (-q id bar
) -> `http://e.com?id=barQuery delete mode: urlmodify -Q <query>
Deletes the given query (and the value if any):
http://e.com?id=foo&page=1
-> (-Q id
) -> http://e.com?page=1
Graft mode: urlmodify -g <graft_point> <new_path_tail>
"Grafts" a new tail on the URL path, possibly removing some of the old tail. Graft point indicates where the old URL is truncated before adding the new path.
graft_point
>= 0 counts path levels, starting from the left
(beginning). 0 will append from the "root", and no existing path will
remain, 1 will keep one path level, and so on.graft_point
< 0 counts from the right (i.e. the end of the current
path). -1 will append to the existing path, -2 will remove the last path
level, and so on.http://website.com/this/is/the/path/component
Graft point: ^ ^ ^ ^ ^ ^
From left: 0 1 2 3 4 5
From right: -6 -5 -4 -3 -2 -1
Examples:
http://e.com/issues/42
-> (-g 0 foo
) -> http://e.com/foo
http://e.com/issues/42
-> (-g 1 foo
) -> http://e.com/issues/foo
http://e.com/issues/42
-> (-g -1 foo
) -> http://e.com/issues/42/foo
http://e.com/issues/42
-> (-g -2 foo
) -> http://e.com/issues/foo
The replace mode:
Go to the parent URL of the current tab's URL
Go to the root domain of the current URL
Opens the current configuration in Firefox's native JSON viewer in the current tab.
NB: Tridactyl cannot run on this page!
The specific key you wish to view (e.g, nmaps).
Display the (HTML) source of the current page.
Behaviour can be changed by the 'viewsource' setting.
If the 'viewsource' setting is set to 'default' rather than 'tridactyl', the url the source of which should be displayed can be given as argument. Otherwise, the source of the current document will be displayed.
Like tabopen, but in a new window
Tridactyl help page
Use
:help <excmd>
or scroll down to show help for a particular excmd.The default keybinds can be found here or all active binds can be seen with
:viewconfig nmaps
. You can also view them with bind. Trybind j
.For more information, and FAQs, check out our readme on github.
Tridactyl is in a pretty early stage of development. Please report any issues and make requests for missing features on the GitHub project page. You can also get in touch using Matrix, Gitter, or IRC chat clients:
All three channels are mirrored together, so it doesn't matter which one you use.
How to use this help page
We've hackily re-purposed TypeDoc which is designed for internal documentation. Every function (excmd) on this page can be called via Tridactyl's command line which we call "ex". There is a slight change in syntax, however. Wherever you see:
function(arg1,arg2)
You should instead type
function arg1 arg2
into the Tridactyl command line (accessed via:
)A "splat" operator (...) means that the excmd will accept any number of space-delimited arguments into that parameter.
You do not need to worry about types. Return values which are promises will turn into whatever they promise to when used in composite.
At the bottom of each function's help page, you can click on a link that will take you straight to that function's definition in our code. This is especially recommended for browsing the config which is nigh-on unreadable on these pages.
Highlighted features:
b
to bring up a list of open tabs in the current window; you can type the tab ID or part of the title or URL to choose a tabShift
+Insert
to enter "ignore mode". PressShift
+Insert
again to return to "normal mode".f
to start "hint mode",F
to open in backgroundo
to:open
a different pages
if you want to search for something that looks like a domain name or URL:bind J tabnext
:help
to see a list of available excmdsyy
to copy the current page URL to your clipboard[[
and]]
to navigate through the pages of comics, paginated articles, etcZZ
will close all tabs and windows, but it will only "save" them if your about:preferences are set to "show your tabs and windows from last time"colours default|dark|greenmat|shydactyl
There are some caveats common to all webextension vimperator-alikes:
about:config
, run fixamo or add a new booleanprivacy.resistFingerprinting.block_mozAddonManager
with the valuetrue
, and remove the above domains fromextensions.webextensions.restrictedDomains
.If you want a more fully-featured vimperator-alike, your best option is Firefox ESR and Vimperator :)