mozilla

Revision 529211 of Developer Toolbar

  • Revision slug: Tools/GCLI
  • Revision title: Developer Toolbar
  • Revision id: 529211
  • Created:
  • Creator: wbamberg
  • Is current revision? No
  • Comment

Revision Content

The Developer Toolbar gives you command-line access to a number of developer tools from within Firefox. The Developer Toolbar is a Graphical Command Line Interpreter: it has the power and conciseness of a command line, but provides integrated help for its commands and can display rich output. It's also extensible: you can add your own local commands and even convert them to add-ons so other people can install them too.

Opening the Developer Toolbar

To open the Developer Toolbar press Shift+F2, or go to the Web Developer menu (which is a submenu in the Tools menu on Mac OSX and Linux) and choose "Developer Toolbar". It appears attached to the bottom of the browser, like this:

The prompt for the command line takes up most of the toolbar, with a "Close" button on the left and a button to toggle the Toolbox on the right.

Apart from the "Close" button, Shift+F2 or the "Developer Toolbar" menu item both toggle the toolbar off.

Using the command line

Like a normal command line, you execute commands by typing them at the prompt and pressing Enter.

As you type, the Developer Toolbar suggests a possible completion to your command:

If there is more than one possible completion, the Up and Down arrow keys cycle through the suggestions. Pressing Tab accepts the current suggestion.

Pressing F1 will display all the suggestions in a list, with a summary of what each command will do:

Typing "help" will show a list of all commands:

Typing "help <command>" will give you the help for <command>:

Extending the Command Line

It's easy to add commands to the command line, either using scratchpad or a mozcmd directory.

See instructions for extending the command line using:

  • A 'mozcmd' directory (requires some setup, commands are persistent)
  • The Scratchpad (requires very little setup, commands not persistent, but can be converted to be addons)

Also see:

Contributing to the Command Line

The Firefox command line is buit using the GCLI project, which has a significant section of documentation on GCLI and how it works. There is also documentation specific to integrating GCLI and Firefox on MDN.

Revision Source

<p>The Developer Toolbar gives you command-line access to a number of developer tools from within Firefox. The Developer Toolbar is a <a href="https://github.com/joewalker/gcli/">Graphical Command Line Interpreter</a>: it has the power and conciseness of a command line, but provides integrated help for its commands and can display rich output. It's also extensible: you can add your own local commands and even convert them to add-ons so other people can install them too.</p>
<h2 id="Opening_the_Developer_Toolbar">Opening the Developer Toolbar</h2>
<p>To open the Developer Toolbar press Shift+F2, or go to the Web Developer menu (which is a submenu in the Tools menu on Mac OSX and Linux) and choose "Developer Toolbar". It appears attached to the bottom of the browser, like this:</p>
<p><img alt="" src="https://mdn.mozillademos.org/files/7275/gcli-annotated.png" style="display: block; margin-left: auto; margin-right: auto;" />The prompt for the command line takes up most of the toolbar, with a "Close" button on the left and a button to toggle the <a href="/en-US/docs/Tools_Toolbox" title="/en-US/docs/Tools_Toolbox">Toolbox</a> on the right.</p>
<p>Apart from the "Close" button, Shift+F2 or the "Developer Toolbar" menu item both toggle the toolbar off.</p>
<h2 id="Using_the_command_line">Using the command line</h2>
<p>Like a normal command line, you execute commands by typing them at the prompt and pressing Enter.</p>
<p>As you type, the Developer Toolbar suggests a possible completion to your command:</p>
<p><img alt="" src="https://mdn.mozillademos.org/files/7277/gcli-completion.png" style="display: block; margin-left: auto; margin-right: auto;" />If there is more than one possible completion, the Up and Down arrow keys cycle through the suggestions. Pressing Tab accepts the current suggestion.</p>
<p>Pressing F1 will display all the suggestions in a list, with a summary of what each command will do:</p>
<p><img alt="" src="https://mdn.mozillademos.org/files/7279/gcli-f1.png" style="display: block; margin-left: auto; margin-right: auto;" /></p>
<p>Typing "help" will show a list of all commands:</p>
<p><img alt="" src="https://mdn.mozillademos.org/files/7281/gcli-help.png" style="display: block; margin-left: auto; margin-right: auto;" />Typing "help &lt;command&gt;" will give you the help for &lt;command&gt;:</p>
<p><img alt="" src="https://mdn.mozillademos.org/files/7283/gcli-help-command.png" style="display: block; margin-left: auto; margin-right: auto;" /></p>
<h2>Extending the Command Line</h2>
<p>It's easy to add commands to the command line, either using scratchpad or a mozcmd directory.</p>
<p>See instructions for extending the command line using:</p>
<ul>
 <li><a href="/en-US/Tools/GCLI/Customization" title="en-US/Tools/GCLI/Customization">A 'mozcmd' directory</a> (requires some setup, commands are persistent)</li>
 <li><a href="/en-US/Tools/GCLI/Scratchpad" title="en-US/Tools/GCLI/Scratchpad">The Scratchpad</a> (requires very little setup, commands not persistent, but can be converted to be addons)</li>
</ul>
<p>Also see:</p>
<ul>
 <li><a href="/en-US/Tools/GCLI/Writing_GCLI_Commands" title="en-US/Tools/GCLI/Writing_GCLI_Commands">Documentation about writing commands</a></li>
</ul>
<h2 id="Contributing_to_the_Command_Line">Contributing to the Command Line</h2>
<p>The Firefox command line is buit using the <a href="https://github.com/joewalker/gcli/" title="https://github.com/joewalker/gcli/">GCLI</a> project, which has a significant <a href="https://github.com/joewalker/gcli/blob/master/docs/index.md" title="https://github.com/joewalker/gcli/blob/master/docs/index.md">section of documentation on GCLI</a> and how it works. There is also documentation specific to <a href="/en-US/docs/Tools/GCLI/Building_GCLI_For_Firefox" title="/en-US/Tools/GCLI/Building_GCLI_For_Firefox">integrating GCLI and Firefox on MDN</a>.</p>
Revert to this revision