HTTPS clone URL
Subversion checkout URL
- Blocklist Guide
- Comparison Table
- FAQ: Does Scriptish pull updates from Greasemonkey?
- FAQ: How does user script updating work?
- FAQ: Reasons why a user script may not work on Scriptish
- FAQ: What are the performance benefits over using GM?
- FAQ: What are the security benefits over Greasemonkey?
- FAQ: Why doesn't Scriptish use GM's "Execution Order" sorting?
- Git Management
- How To: Build an .xpi from source
- How To: Manually transfer user scripts from Greasemonkey to Scriptish
- How To: Run Scriptish from source
- How To: Deal with conflicting user scripts
- How To: Submit a bug, issue, or feature request
- Manual: API
- Manual: Metadata Block
- Manual: Preferences
- Release Process
- Running Tests
- Version History
- wiki scriptish
- Writing Tests
Clone this wiki locally
Scriptish offers a few API methods which provide extra functionality to user scripts.
GM_getMetadata (new in Scriptish!)
This function provides access to a user script's metadata block.
console (improved in Scriptish!)
console, ensuring the availability of the
trace methods regardless of the console implementation.
Always equal to
true. Check if this exists to see if your user script engine supports @updateURL.
Provides access to the raw
window, which is usually used to access functions defined on a page.
GM_safeHTMLParser (new in Scriptish!)
This function will safely parse a string of HTML and return a document object. It cleans the provided HTML by removing tags like
GM_xmlhttpRequest (improved in Scriptish!)
This function is a cross-origin version of XMLHttpRequest. The beauty of this function is that a user script can make requests that do not use the same-origin policy, creating opportunities for powerful mashups.
GM_xpath (new in Scriptish!)
This function will remove a user script preference.
This function will retrieve a user script preference.
This function will return a list of a user script's preferences.
GM_setValue (improved in Scriptish!)
This function will set a user script preference.
Note: Resources are included with a Metadata Block's @resource key.
This function will return the plain text content of a @resource.
This function will return the contents of the @resource as a data: URL.
GM_log (improved in Scriptish!)
GM_notification (new in Scriptish!)
This function sends a Growl-style notification/message to the user.
GM_openInTab (improved in Scriptish!)
This function opens a URL in a new tab, or optionally an existing tab.
GM_registerMenuCommand (improved in Scriptish!)
This function will add a menu item to the Scriptish menu under "User Script Commands".
GM_unregisterMenuCommand (new in Scriptish!)
This function will remove a GM_registerMenuCommand-created menu item from the Scriptish menu.
GM_enableMenuCommand (new in Scriptish!)
This function will enable a GM_registerMenuCommand-created menu item in the Scriptish menu.
GM_disableMenuCommand (new in Scriptish!)
This function will disable a GM_registerMenuCommand-created menu item in the Scriptish menu.
GM_setClipboard (new in Scriptish!)
This function will save data to the clipboard.
GM_addStyle (improved in Scriptish!)
This function takes a string of CSS and adds it to the page.
GM_cryptoHash (new in Scriptish!)
This function will allow you to easily hash a string.