You are viewing the documentation for Pilosa v1.2. View the latest documentation for Pilosa v1.4.0.


A web-based app called Pilosa Console is available in a separate package. This can be used for constructing queries and viewing the cluster status.


Releases are available on Github as well as on Homebrew for Mac.

Installing on a Mac with Homebrew is simple; just run:

brew tap pilosa/homebrew-pilosa
brew install pilosa-console

You may also build from source by checking out the repo on Github and running:

make install


The Query tab allows you to enter PQL queries and run them against your locally running server. First you must select an Index with the Select index dropdown.

Each query’s result will be displayed in the Output section along with the query time.

The Console will keep a record of each query and its result with the latest query on top.

Console screenshot Console query screenshot

In addition to standard PQL, the console supports a few special commands, prefixed with :.

  • :create index <indexname>
  • :delete index <indexname>
  • :use <indexname>
  • :create field <fieldname>
  • :delete field <fieldname>

Field creation also supports options like timeQuantum. When creating a new field, add options by using the keys documented in API reference.

  • :create field <fieldname> cacheSize=10000

Cluster Admin

Use the Cluster Admin tab to view the current status of your cluster. This contains information on each node in the cluster, plus the list of Indexes and Fields.

View markdown source on Github. Last updated 1 year, 5 months ago.