Tridactyl help page

Use :help <excmd> or scroll down to show help for a particular excmd. If you're still stuck, you might consider reading through the :tutor again.

The default keybinds and settings can be found here and active binds can be seen with :viewconfig nmaps or with bind.

Tridactyl also provides a few functions to manipulate text in the command line or text areas that can be found here. There are also a few commands only available in the command line which can be found here.

Ex-commands available exclusively in hint mode are listed here

We also have a wiki which may be edited by anyone.

How to use this help page

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.

Above each function signature you will see any aliases or key sequences bound to it. The internal names for the various modes are used, which are listed here:

- `nmaps`: normal mode binds
- `imaps`: insert mode binds
- `inputmaps`: input mode binds
- `ignoremaps`: ignore mode binds
- `exaliases`: aliases in the command mode
- `exmaps`: commandline mode binds

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.

You do not need to worry about types. Return values which are promises will turn into whatever they promise to when used in composite.

Caveats

There are some caveats common to all webextension vimperator-alikes:

To make Tridactyl work on addons.mozilla.org and some other Mozilla domains, you need to open about:config and add a new boolean privacy.resistFingerprinting.block_mozAddonManager with the value true, as well as remove those domains from extensions.webextensions.restrictedDomains.
Tridactyl can't run on about:*, some file:* URIs, view-source:*, or data:*, URIs.
To change/hide the GUI of Firefox from Tridactyl, you can use guiset with the native messenger installed (see native and nativeinstall). Alternatively, you can edit your userChrome yourself.

Getting help

For more information, and FAQs, check out our readme and troubleshooting guide 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.

Functions

abbreviate
addTridactylEditorClass
apropos
autocmd
autocmddelete
autocontain
autocontaindelete
back
bind
bindshow
bindurl
bindwizard
blacklistadd
bmark
bmarks
changelistjump
clearsearchhighlight
clipboard
colourscheme
comclear
command
composite
containerclose
containercreate
containerdelete
containerupdate
credits
cssparse
define
dialog
drawingerasertoggle
drawingstart
echo
editor
elementunhide
escapehatch
exclaim
exclaim_quiet
extoptions
fillcmdline
fillcmdline_nofocus
fillcmdline_notrail
fillcmdline_tmp
fillinput
find
findnext
findselect
firefoxsyncpull
firefoxsyncpush
fixamo
fixamo_quiet
focusbyid
focusinput
followpage
forward
fullscreen
get
getclip
getGotoSelectors
getinput
getInputSelector
getNativeVersion
getRssLinks
geturlsforlinks
gobble
goto
guiset
guiset_quiet
help
hidecmdline
hint
hintinput
hintstylesdirect
hintstylesnohighlights
hintstylesoverlays
home
issue
js
jsb
jsonview
jsua
jumble
jumpnext
jumpprev
keyfeed
keymap
loadaucmds
loadtheme
markadd
markaddglobal
markaddlocal
markjump
markjumpbefore
markjumpglobal
markjumplocal
mktridactylrc
mode
mouse_mode
mute
native
nativeinstall
nativeopen
neo_mouse_mode
nmode
no_mouse_mode
open
open_quiet
perfdump
perfhistogram
pied_piper_mouse_mode
pin
profilecreate
profilelaunch
profilerename
proxyadd
proxyremove
qall
quickmark
quickmarkremove
reader
readerold
recontain
reload
reloadall
reloadallbut
reloaddead
reloadhard
removepref
removeTridactylEditorClass
repeat
reset
reseturl
restart
rot13
rssexec
run_exstr
sanitise
saveas
scrollline
scrollpage
scrollpx
scrollstart
scrollstop
scrolltab
scrollto
searchsetkeyword
set
setContentStateGroup
setmode
setnull
setpref
seturl
shellescape
showcmdline
sidebaropen
sidebartoggle
sleep
snow_mouse_mode
source
source_quiet
tab
tab_helper
taball
tabaudio
tabclose
tabcloseallto
tabdetach
tabdiscard
tabduplicate
tabfirst
tabgrab
tablast
tabmove
tabnext
tabnext_gt
tabonly
tabopen
tabopenwait
tabprev
tabpush
tabqueue
tabrename
tabsort
text2qr
tgroupabort
tgroupclose
tgroupcreate
tgrouplast
tgroupmove
tgrouprename
tgroupswitch
tstattach
tstmove
tstmoveafter
ttscontrol
ttsread
ttsvoices
tutor
unabbreviate
unbind
unbindurl
undo
unfocus
unkeymap
unloadtheme
unset
unsetmode
unseturl
updatecheck
updatenative
url2args
urlincrement
urlmodify
urlmodify_js
urlparent
urlroot
version
viewconfig
viewcontainers
viewsource
winclose
winmerge
winopen
wintitle
yank
yankimage
zoom

Functions

abbreviate

abbreviate(abbreviation: string, ...expansion: string[]): Promise<any>
Parameters
- abbreviation: string
- ...expansion: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3993

addTridactylEditorClass

addTridactylEditorClass(selector: string): Promise<any>
Parameters
- selector: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:255

apropos

apropos(...helpItems: string[]): Promise<any>
Parameters
- ...helpItems: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1622

autocmd

autocmd(event: string, url: string, ...excmd: string[]): Promise<any>
Parameters
- event: string
- url: string
- ...excmd: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4425

autocmddelete

autocmddelete(event: string, url: string): Promise<any>
Parameters
- event: string
- url: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4536

autocontain

autocontain(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4472

autocontaindelete

autocontaindelete(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4490

back

back(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1295

bind

bind(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:4063

bindshow

bindshow(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4102

bindurl

bindurl(
    pattern: string,
    mode: string,
    keys: string,
    ...excmd: string[],
): Promise<void>
Parameters
- pattern: string
- mode: string
- keys: string
- ...excmd: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:4139

bindwizard

bindwizard(...args: string[]): Promise<any>
Generate a key sequence from keypresses. Once Enter is pressed, the command line is filled with a bind command with the key sequence and provided arguments, which you can choose to modify and execute.

If you have :set keyboardlayoutforce true, it will bind commands to physical keys regardless of layout.

Accepts the same arguments as bind (except for the key sequence which will be generated):
```
- `bindwizard [command]`, then press the keys you want to bind, then hit Enter.
- `bindwizard --mode=[mode] [command]` also works.
```
You can execute it without arguments to see what is bound to the keys you type.
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4120

blacklistadd

blacklistadd(url: string): Promise<any>
Parameters
- url: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4557

bmark

bmark(url?: string, ...titlearr: string[]): Promise<BookmarkTreeNode>
Parameters
- Optionalurl: string
- ...titlearr: string[]
Returns Promise<BookmarkTreeNode>
- Defined in .excmds_background.generated.ts:5347

bmarks

bmarks(opt: string, ...urlarr: string[]): Promise<any>
Parameters
- opt: string
- ...urlarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1387

changelistjump

changelistjump(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2109

clearsearchhighlight

clearsearchhighlight(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1250

clipboard

clipboard(
    excmd?:
        | "open"
        | "tabopen"
        | "yank"
        | "yankshort"
        | "yankcanon"
        | "yanktitle"
        | "yankmd"
        | "yankorg"
        | "xselpaste",
    ...toYank: string[],
): Promise<any>
Parameters
- excmd:
      | "open"
      | "tabopen"
      | "yank"
      | "yankshort"
      | "yankcanon"
      | "yanktitle"
      | "yankmd"
      | "yankorg"
      | "xselpaste" = "open"
- ...toYank: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3754

colourscheme

colourscheme(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:457

comclear

comclear(name: string): void
Parameters
- name: string
Returns void
- Defined in .excmds_background.generated.ts:3987

command

command(name: string, ...definition: string[]): Promise<any>
Parameters
- name: string
- ...definition: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3964

composite

composite(...cmds: string[]): Promise<any>
Parameters
- ...cmds: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3520

containerclose

containerclose(...name: string[]): Promise<void>
Parameters
- ...name: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3068

containercreate

containercreate(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3083

containerdelete

containerdelete(...name: string[]): Promise<void>
Parameters
- ...name: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3093

containerupdate

containerupdate(
    name: string,
    uname: string,
    ucolor: string,
    uicon: string,
): Promise<void>
Parameters
- name: string
- uname: string
- ucolor: string
- uicon: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3115

credits

credits(): Promise<Tab>
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:1645

cssparse

cssparse(...css: string[]): void
Parameters
- ...css: string[]
Returns void
- Defined in .excmds_background.generated.ts:400

define

define(...words: string[]): Promise<any>
Parameters
- ...words: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1614

dialog

dialog(...nameArgs: string[]): Promise<void>
Parameters
- ...nameArgs: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:636

drawingerasertoggle

drawingerasertoggle(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1733

drawingstart

drawingstart(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1720

echo

echo(...str: string[]): string
Parameters
- ...str: string[]
Returns string
- Defined in .excmds_background.generated.ts:5406

editor

editor(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:302

elementunhide

elementunhide(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5789

escapehatch

escapehatch(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3583

exclaim

exclaim(...str: string[]): Promise<void>
Parameters
- ...str: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:658

exclaim_quiet

exclaim_quiet(...str: string[]): Promise<string>
Parameters
- ...str: string[]
Returns Promise<string>
- Defined in .excmds_background.generated.ts:670

extoptions

extoptions(...optionNameArgs: string[]): Promise<any>
Parameters
- ...optionNameArgs: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5749

fillcmdline

fillcmdline(...strarr: string[]): Promise<any>
Parameters
- ...strarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3623

fillcmdline_nofocus

fillcmdline_nofocus(...strarr: string[]): Promise<any>
Parameters
- ...strarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3645

fillcmdline_notrail

fillcmdline_notrail(...strarr: string[]): Promise<any>
Parameters
- ...strarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3634

fillcmdline_tmp

fillcmdline_tmp(ms: number, ...strarr: string[]): Promise<any>
Parameters
- ms: number
- ...strarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3656

fillinput

fillinput(selector: string, ...content: string[]): Promise<any>
Parameters
- selector: string
- ...content: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:220

find

find(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1221

findnext

findnext(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1240

findselect

findselect(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1263

firefoxsyncpull

firefoxsyncpull(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4336

firefoxsyncpush

firefoxsyncpush(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4348

fixamo

fixamo(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:534

fixamo_quiet

fixamo_quiet(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:516

focusbyid

focusbyid(id: string): Promise<any>
Parameters
- id: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:2141

focusinput

focusinput(nth: string | number): Promise<any>
Parameters
- nth: string | number
Returns Promise<any>
- Defined in .excmds_background.generated.ts:2083

followpage

followpage(rel?: "next" | "prev"): Promise<any>
Parameters
- rel: "next" | "prev" = "next"
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1789

forward

forward(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1280

fullscreen

fullscreen(): Promise<Window>
Returns Promise<Window>
- Defined in .excmds_background.generated.ts:2635

get

get(...keys: string[]): any
Parameters
- ...keys: string[]
Returns any
- Defined in .excmds_background.generated.ts:4823

getclip

getclip(from?: "clipboard" | "selection"): Promise<string>
Parameters
- Optionalfrom: "clipboard" | "selection"
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3715

getGotoSelectors

getGotoSelectors(): Promise<
{ level: number; selector: string; title: string; y: number }[],
>
Returns Promise<{ level: number; selector: string; title: string; y: number }[]>
- Defined in .excmds_background.generated.ts:5149

getinput

getinput(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:233

getInputSelector

getInputSelector(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:244

getNativeVersion

getNativeVersion(): Promise<string>
Returns Promise<string>
- Defined in .excmds_background.generated.ts:178

getRssLinks

getRssLinks(): Promise<{ title: string; type: string; url: string }[]>
Returns Promise<{ title: string; type: string; url: string }[]>
- Defined in .excmds_background.generated.ts:186

geturlsforlinks

geturlsforlinks(reltype?: string, rel: string): Promise<any>
Parameters
- reltype: string = "rel"
- rel: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1965

gobble

gobble(
    numKeysOrTerminator: string,
    endCmd: string,
    ...args: string[],
): Promise<any>
Parameters
- numKeysOrTerminator: string
- endCmd: string
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5134

goto

goto(...selector: string[]): Promise<any>
Parameters
- ...selector: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5162

guiset

guiset(rule: string, option: string): Promise<any>
Parameters
- rule: string
- option: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:389

guiset_quiet

guiset_quiet(rule: string, option: string): Promise<any>
Parameters
- rule: string
- option: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:315

help

help(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1495

hidecmdline

hidecmdline(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3608

hint

hint(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5042

hintinput

hintinput(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:2094

hintstylesdirect

hintstylesdirect(): void
Style hintable elements directly when hinting.

Returns void
- Defined in .excmds_background.generated.ts:5916

hintstylesnohighlights

hintstylesnohighlights(): void
Disable all hilighting of hintable elements when hinting. Only hint flags will remain, Vimium style.

Returns void
- Defined in .excmds_background.generated.ts:5901

hintstylesoverlays

hintstylesoverlays(): void
Add highlights over the page when hinting and leave original elements unchanged.

Returns void
- Defined in .excmds_background.generated.ts:5908

home

home(all?: "false" | "true"): Promise<any>
Parameters
- all: "false" | "true" = "false"
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1451

issue

issue(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5612

js

js(...str: string[]): Promise<any>
Parameters
- ...str: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5563

jsb

jsb(...str: string[]): Promise<any>
Parameters
- ...str: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5604

jsonview

jsonview(...json: string[]): Promise<Tab>
Parameters
- ...json: string[]
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:4865

jsua

jsua(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3048

jumble

jumble(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5085

jumpnext

jumpnext(n?: number): Promise<any>
Parameters
- n: number = 1
Returns Promise<any>
- Defined in .excmds_background.generated.ts:958

jumpprev

jumpprev(n?: number): Promise<any>
Parameters
- n: number = 1
Returns Promise<any>
- Defined in .excmds_background.generated.ts:974

keyfeed

keyfeed(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5718

keymap

keymap(source: string, target: string): Promise<any>
Parameters
- source: string
- target: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4164

loadaucmds

loadaucmds(
    cmdType:
        | "DocBlur"
        | "DocEnd"
        | "DocFocus"
        | "DocLoad"
        | "DocStart"
        | "FullscreenChange"
        | "FullscreenEnter"
        | "FullscreenLeft"
        | "ModeEnter"
        | "ModeLeave"
        | "TabEnter"
        | "TabLeft"
        | "UriChange"
        | "HistoryState",
    target?: string,
): Promise<any>
Parameters
- cmdType:
      | "DocBlur"
      | "DocEnd"
      | "DocFocus"
      | "DocLoad"
      | "DocStart"
      | "FullscreenChange"
      | "FullscreenEnter"
      | "FullscreenLeft"
      | "ModeEnter"
      | "ModeLeave"
      | "TabEnter"
      | "TabLeft"
      | "UriChange"
      | "HistoryState"
- Optionaltarget: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:2028

loadtheme

loadtheme(themename: string): Promise<any>
Parameters
- themename: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:406

markadd

markadd(key: string): Promise<any>
Parameters
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1060

markaddglobal

markaddglobal(key: string): Promise<any>
Parameters
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1094

markaddlocal

markaddlocal(key: string): Promise<any>
Parameters
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1080

markjump

markjump(key: string): Promise<any>
Parameters
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:989

markjumpbefore

markjumpbefore(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1032

markjumpglobal

markjumpglobal(key: string): Promise<any>
Parameters
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1018

markjumplocal

markjumplocal(key: string): Promise<any>
Parameters
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1003

mktridactylrc

mktridactylrc(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:757

mode

mode(mode: ModeName): Promise<any>
Parameters
- mode: ModeName
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3441

mouse_mode

mouse_mode(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1747

mute

mute(...muteArgs: string[]): Promise<void>
Parameters
- ...muteArgs: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2873

native

native(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:684

nativeinstall

nativeinstall(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:710

nativeopen

nativeopen(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:553

neo_mouse_mode

neo_mouse_mode(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1677

nmode

nmode(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5187

no_mouse_mode

no_mouse_mode(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1660

open

open(...urlarr: string[]): Promise<any>
Parameters
- ...urlarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1369

open_quiet

open_quiet(...urlarr: string[]): Promise<any>
Parameters
- ...urlarr: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1396

perfdump

perfdump(...filters: string[]): Promise<any>
Parameters
- ...filters: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5301

perfhistogram

perfhistogram(...filters: string[]): Promise<any>
Parameters
- ...filters: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5317

pied_piper_mouse_mode

pied_piper_mouse_mode(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1703

pin(index: string): Promise<Tab>
Parameters
- index: string
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2860

profilecreate

profilecreate(profileName: string): Promise<void>
Parameters
- profileName: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:5864

profilelaunch

profilelaunch(profileName?: string): Promise<void>
Parameters
- OptionalprofileName: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:5844

profilerename

profilerename(oldName: string, newName: string): Promise<void>
Parameters
- oldName: string
- newName: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:5883

proxyadd

proxyadd(name: string, url: string): Promise<any>
Parameters
- name: string
- url: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4511

proxyremove

proxyremove(name: string): void
Parameters
- name: string
Returns void
- Defined in .excmds_background.generated.ts:4523

qall

qall(): Promise<void[]>
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:3021

quickmark

quickmark(key: string, ...addressarr: string[]): Promise<void>
Parameters
- key: string
- ...addressarr: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:4773

quickmarkremove

quickmarkremove(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:4809

reader

reader(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5774

readerold

readerold(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2013

recontain

recontain(...containerName: string[]): Promise<void>
Parameters
- ...containerName: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3149

reload

reload(n?: number, hard?: boolean): Promise<void[]>
Parameters
- n: number = 1
- hard: boolean = false
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:1306

reloadall

reloadall(hard?: boolean): Promise<void[]>
Parameters
- hard: boolean = false
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:1314

reloadallbut

reloadallbut(hard?: boolean): Promise<void[]>
Parameters
- hard: boolean = false
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:1324

reloaddead

reloaddead(hard?: boolean): Promise<void[]>
Parameters
- hard: boolean = false
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:1335

reloadhard

reloadhard(n?: number): Promise<void[]>
Parameters
- n: number = 1
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:1344

removepref

removepref(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:506

removeTridactylEditorClass

removeTridactylEditorClass(selector: string): Promise<any>
Parameters
- selector: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:266

repeat

repeat(n?: number, ...exstr: string[]): Promise<void>
Parameters
- n: number = 1
- ...exstr: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3497

reset

reset(mode: string, key: string): Promise<any>
Parameters
- mode: string
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4632

reseturl

reseturl(pattern: string, mode: string, key: string): Promise<any>
Parameters
- pattern: string
- mode: string
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4652

restart

restart(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:876

rot13

rot13(n: number): Promise<any>
Parameters
- n: number
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5068

rssexec

rssexec(url: string, type?: string, ...title: string[]): Promise<any>
Parameters
- url: string
- Optionaltype: string
- ...title: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:205

run_exstr

run_exstr(...commands: string[]): Promise<any>
Parameters
- ...commands: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5100

sanitise

sanitise(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:4683

saveas

saveas(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:914

scrollline

scrollline(n?: number, mult?: number): Promise<any>
Parameters
- n: number = 1
- mult: number = 1
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1170

scrollpage

scrollpage(n?: number, count?: number): Promise<any>
Parameters
- n: number = 1
- count: number = 1
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1186

scrollpx

scrollpx(a: number, b: number): Promise<any>
Parameters
- a: number
- b: number
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1134

scrollstart

scrollstart(xVelocity: string, yVelocity: string, mult?: string): Promise<any>
Parameters
- xVelocity: string
- yVelocity: string
- Optionalmult: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5939

scrollstop

scrollstop(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5954

scrolltab

scrolltab(
    tabId: number,
    scrollX: number,
    scrollY: number,
    message: string,
): Promise<any>
Parameters
- tabId: number
- scrollX: number
- scrollY: number
- message: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1045

scrollto

scrollto(a: string | number, b?: number | "x" | "y"): Promise<any>
Parameters
- a: string | number
- b: number | "x" | "y" = "y"
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1154

searchsetkeyword

searchsetkeyword(): void
Returns void
- Defined in .excmds_background.generated.ts:4182

set

set(key: string, ...values: string[]): any
Parameters
- key: string
- ...values: string[]
Returns any
- Defined in .excmds_background.generated.ts:4297

setContentStateGroup

setContentStateGroup(name: string): Promise<any>
Parameters
- name: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3184

setmode

setmode(mode: string, key: string, ...values: string[]): Promise<any>
Parameters
- mode: string
- key: string
- ...values: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4273

setnull

setnull(...keys: string[]): Promise<any>
Parameters
- ...keys: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4930

setpref

setpref(key: string, ...value: string[]): Promise<void>
Parameters
- key: string
- ...value: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:495

seturl

seturl(pattern: string, key: string, ...values: string[]): Promise<any>
Parameters
- pattern: string
- key: string
- ...values: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4249

shellescape

shellescape(...quoteme: string[]): Promise<string>
Escape command for safe use in shell with composite. E.g: composite js MALICIOUS_WEBSITE_FUNCTION() | shellescape | exclaim ls
Parameters
- ...quoteme: string[]
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3560

showcmdline

showcmdline(focus?: boolean): Promise<any>
Parameters
- focus: boolean = true
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3597

sidebaropen

sidebaropen(...urllike: string[]): Promise<void>
Parameters
- ...urllike: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3036

sidebartoggle

sidebartoggle(): Promise<void>
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3058

sleep

sleep(time_ms: number): Promise<unknown>
Parameters
- time_ms: number
Returns Promise<unknown>
- Defined in .excmds_background.generated.ts:3591

snow_mouse_mode

snow_mouse_mode(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1690

source

source(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:806

source_quiet

source_quiet(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:830

tab

tab(...id: string[]): Promise<any>
Parameters
- ...id: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3861

tab_helper

tab_helper(
    interactive: boolean,
    anyWindow: boolean,
    ...key: string[],
): Promise<any>
Parameters
- interactive: boolean
- anyWindow: boolean
- ...key: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3905

taball

taball(...id: string[]): Promise<any>
Parameters
- ...id: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3868

tabaudio

tabaudio(): Promise<Tab>
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2272

tabclose

tabclose(...indexes: string[]): Promise<void>
Parameters
- ...indexes: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2652

tabcloseallto

tabcloseallto(side: string): Promise<void>
Parameters
- side: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2684

tabdetach

tabdetach(index?: string): Promise<Window>
Parameters
- Optionalindex: string
Returns Promise<Window>
- Defined in .excmds_background.generated.ts:2611

tabdiscard

tabdiscard(index: string): Promise<void>
Parameters
- index: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2706

tabduplicate

tabduplicate(index?: number): Promise<Tab>
Parameters
- Optionalindex: number
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2601

tabfirst

tabfirst(): Promise<Tab>
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2169

tabgrab

tabgrab(id: string): Promise<Tab | Tab[]>
Parameters
- id: string
Returns Promise<Tab | Tab[]>
- Defined in .excmds_background.generated.ts:2326

tablast

tablast(): Promise<Tab>
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2175

tabmove

tabmove(index?: string): Promise<Tab | Tab[]>
Parameters
- index: string = "$"
Returns Promise<Tab | Tab[]>
- Defined in .excmds_background.generated.ts:2774

tabnext

tabnext(...args: string[]): Promise<Tab>
Parameters
- ...args: string[]
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2186

tabnext_gt

tabnext_gt(index?: number): Promise<any>
Parameters
- Optionalindex: number
Returns Promise<any>
- Defined in .excmds_background.generated.ts:2198

tabonly

tabonly(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2580

tabopen

tabopen(...addressarr: string[]): Promise<Tab>
Parameters
- ...addressarr: string[]
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2373

tabopenwait

tabopenwait(...addressarr: string[]): Promise<Tab>
Parameters
- ...addressarr: string[]
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2381

tabprev

tabprev(...args: string[]): Promise<Tab>
Parameters
- ...args: string[]
Returns Promise<Tab>
- Defined in .excmds_background.generated.ts:2215

tabpush

tabpush(windowId?: number): Promise<Tab | Tab[]>
Parameters
- OptionalwindowId: number
Returns Promise<Tab | Tab[]>
- Defined in .excmds_background.generated.ts:2254

tabqueue

tabqueue(...addresses: string[]): Promise<unknown>
Parameters
- ...addresses: string[]
Returns Promise<unknown>
- Defined in .excmds_background.generated.ts:2508

tabrename

tabrename(index: string, ...name: string[]): Promise<any>
Parameters
- index: string
- ...name: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3888

tabsort

tabsort(...callbackchunks: string[]): Promise<void>
Parameters
- ...callbackchunks: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2848

text2qr

text2qr(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5637

tgroupabort

tgroupabort(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3407

tgroupclose

tgroupclose(name?: string): Promise<string>
Parameters
- Optionalname: string
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3319

tgroupcreate

tgroupcreate(name: string): Promise<string>
Parameters
- name: string
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3211

tgrouplast

tgrouplast(): Promise<string>
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3281

tgroupmove

tgroupmove(name: string): Promise<string>
Parameters
- name: string
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3359

tgrouprename

tgrouprename(name: string): Promise<string>
Parameters
- name: string
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3296

tgroupswitch

tgroupswitch(name: string): Promise<string>
Parameters
- name: string
Returns Promise<string>
- Defined in .excmds_background.generated.ts:3257

tstattach

tstattach(index: string): Promise<void>
Parameters
- index: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:5825

tstmove

tstmove(index: string): Promise<void>
Parameters
- index: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:5803

tstmoveafter

tstmoveafter(index: string): Promise<void>
Parameters
- index: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:5814

ttscontrol

ttscontrol(action: "pause" | "play" | "stop" | "playpause"): Promise<any>
Parameters
- action: "pause" | "play" | "stop" | "playpause"
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5250

ttsread

ttsread(mode: "-t" | "-c", ...args: string[]): Promise<any>
Parameters
- mode: "-t" | "-c"
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5219

ttsvoices

ttsvoices(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:5233

tutor

tutor(newtab?: string): Promise<any>
Parameters
- Optionalnewtab: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1630

unabbreviate

unabbreviate(abbreviation: string): Promise<any>
Parameters
- abbreviation: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4000

unbind

unbind(...args: string[]): Promise<void>
Parameters
- ...args: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:4576

unbindurl

unbindurl(pattern: string, mode: string, keys: string): Promise<any>
Parameters
- pattern: string
- mode: string
- keys: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4615

undo

undo(item?: string): Promise<number>
Parameters
- item: string = "recent"
Returns Promise<number>
- Defined in .excmds_background.generated.ts:2731

unfocus

unfocus(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1122

unkeymap

unkeymap(source: string): Promise<any>
Parameters
- source: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4174

unloadtheme

unloadtheme(themename: string): Promise<any>
Parameters
- themename: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:424

unset

unset(...keys: string[]): Promise<any>
Parameters
- ...keys: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4920

unsetmode

unsetmode(mode: string, key: string): Promise<any>
Parameters
- mode: string
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4907

unseturl

unseturl(pattern: string, key: string): Promise<any>
Parameters
- pattern: string
- key: string
Returns Promise<any>
- Defined in .excmds_background.generated.ts:4885

updatecheck

updatecheck(
source?: "manual" | "auto_polite" | "auto_impolite",
): Promise<boolean>
Parameters
- source: "manual" | "auto_polite" | "auto_impolite" = "manual"
Returns Promise<boolean>
- Defined in .excmds_background.generated.ts:5657

updatenative

updatenative(interactive?: boolean): Promise<void>
Parameters
- interactive: boolean = true
Returns Promise<void>
- Defined in .excmds_background.generated.ts:844

url2args

url2args(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1415

urlincrement

urlincrement(count?: number, multiplier?: number): Promise<any>
Parameters
- count: number = 1
- multiplier: number = 1
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1805

urlmodify

urlmodify(
    mode:
        | "-t"
        | "-s"
        | "-r"
        | "-g"
        | "--safe"
        | "-q"
        | "-Q"
        | "-tu"
        | "-ru"
        | "-su"
        | "-qu"
        | "-Qu"
        | "-gu",
    ...args: string[],
): Promise<any>
Parameters
- mode:
      | "-t"
      | "-s"
      | "-r"
      | "-g"
      | "--safe"
      | "-q"
      | "-Q"
      | "-tu"
      | "-ru"
      | "-su"
      | "-qu"
      | "-Qu"
      | "-gu"
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1932

urlmodify_js

urlmodify_js(
    mode:
        | "-t"
        | "-s"
        | "-r"
        | "-g"
        | "-q"
        | "-Q"
        | "-tu"
        | "-ru"
        | "-su"
        | "-qu"
        | "-Qu"
        | "-gu",
    ...args: string[],
): Promise<any>
Parameters
- mode:
      | "-t"
      | "-s"
      | "-r"
      | "-g"
      | "-q"
      | "-Q"
      | "-tu"
      | "-ru"
      | "-su"
      | "-qu"
      | "-Qu"
      | "-gu"
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1949

urlparent

urlparent(count?: number): Promise<any>
Parameters
- count: number = 1
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1829

urlroot

urlroot(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1817

version

version(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3420

viewconfig

viewconfig(...key: string[]): void
Parameters
- ...key: string[]
Returns void
- Defined in .excmds_background.generated.ts:4845

viewcontainers

viewcontainers(): Promise<any>
Returns Promise<any>
- Defined in .excmds_background.generated.ts:3128

viewsource

viewsource(url?: string): Promise<any>
Parameters
- url: string = ""
Returns Promise<any>
- Defined in .excmds_background.generated.ts:1433

winclose

winclose(...ids: string[]): Promise<void[]>
Parameters
- ...ids: string[]
Returns Promise<void[]>
- Defined in .excmds_background.generated.ts:2997

winmerge

winmerge(...windowIds: string[]): Promise<void>
Parameters
- ...windowIds: string[]
Returns Promise<void>
- Defined in .excmds_background.generated.ts:2285

winopen

winopen(...args: string[]): Promise<any>
Parameters
- ...args: string[]
Returns Promise<any>
- Defined in .excmds_background.generated.ts:2940

wintitle

wintitle(...title: string[]): Promise<Window>
Parameters
- ...title: string[]
Returns Promise<Window>
- Defined in .excmds_background.generated.ts:3012

yank

yank(...content: string[]): Promise<any[]>
Parameters
- ...content: string[]
Returns Promise<any[]>
- Defined in .excmds_background.generated.ts:3671

yankimage

yankimage(url: string): Promise<void>
Parameters
- url: string
Returns Promise<void>
- Defined in .excmds_background.generated.ts:3832

zoom

zoom(level?: number, rel?: string, tabId?: string): Promise<void>
Parameters
- level: number = 0
- rel: string = "false"
- tabId: string = "auto"
Returns Promise<void>
- Defined in .excmds_background.generated.ts:1985

Tridactyl help page

How to use this help page

Caveats

Getting help

Functions

Functions

abbreviate

Parameters

Returns Promise<any>

addTridactylEditorClass

Parameters

Returns Promise<any>

apropos

Parameters

Returns Promise<any>

autocmd

Parameters

Returns Promise<any>

autocmddelete

Parameters

Returns Promise<any>

autocontain

Parameters

Returns Promise<any>

autocontaindelete

Parameters

Returns Promise<any>

back

Parameters

Returns Promise<any>

bind

Parameters

Returns Promise<void>

bindshow

Parameters

Returns Promise<any>

bindurl

Parameters

Returns Promise<void>

bindwizard

Parameters

Returns Promise<any>

blacklistadd

Parameters

Returns Promise<any>

bmark

Parameters

Returns Promise<BookmarkTreeNode>

bmarks

Parameters

Returns Promise<any>

changelistjump

Returns Promise<void>

clearsearchhighlight

Returns Promise<any>

clipboard

Parameters

Returns Promise<any>

colourscheme

Parameters

Returns Promise<any>

comclear

Parameters

Returns void

command

Parameters

Returns Promise<any>

composite

Parameters

Returns Promise<any>

containerclose

Parameters

Returns Promise<void>

containercreate

Parameters

Returns Promise<void>

containerdelete

Parameters

Returns Promise<void>

containerupdate