Pixsy Docs

Pixsy | Command Your Internet

Current version: 0.5.11

User Commands

What is a user command?

Pixsy's built-in commands can be extended by users to allow for the development of commands for any website with an accessible URL. The user commands can function purely as links to websites, or they can be used with a search term to develop new search functions.

User command syntax

<usercommand> http://www.someurl.com/search?q={pixsy}

The name that you assign to your command can range in length between 1 and 20 characters. You can use lowercase and uppercase letters, the numbers 0-9, and the underscore character.

Note the sequence that is used to make your command. The user command is placed between the < and > characters. There is a space between this and the URL.

The placeholder for search commands

The URL is entered with an optional placeholder {pixsy} for a search term. If the command is to be used as a direct link to a site without input from the user at the command line, then the placeholder is optional. If the command requires the user to enter a query at the command line (i.e. user input is required), then the {pixsy} placeholder should be positioned where Pixsy should insert the search term in the URL.

In the example above, the q= parameter is passed to the server to indicate the search term entered by the user. The location where Pixsy should insert the query that the user enters at the command line is indicated with the {pixsy} placeholder.

Example

Here is an example of how a search command could be entered to search the Mashable website:

<mashable> https://mashable.com/follow/search/?q={pixsy}&commit=Search

Screencast Tutorial

This video tutorial demonstrates how to make and use Pixsy user commands to create new search functions and website links. Running time = 11:38