pictobot v0.0.4

Pictobot

Command line utility for crawling and uploading snapshots to Pictograph

Getting Started

Installing

• Download and install the latest version of node.js if you don't have it already

• Install pictobot with the following command, depending on the system, you might have to run this with super user permissions (sudo)

  npm install -g pictobot

Commands

Getting Help

Just run the pictobot with --help option to get all the available options

╔═╗┬┌─┐┌┬┐┌─┐┌┐ ┌─┐┌┬┐
╠═╝││   │ │ │├┴┐│ │ │ 
╩  ┴└─┘ ┴ └─┘└─┘└─┘ ┴ 


  Usage: index [options] [command]


  Commands:

    crawl [url] [eventId]  crawls the given url to capture snapshots
    configure [token]      configures the current folder with the project token
    help                   [object Object]
    help [cmd]             display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Configuring

• To use pictobot, you should have a registered and active account with Pictograph

• After you have created a project, please go to the documentation page to generate a token. This token is in the JWT format.

• Run the following command

pictobot configure <generated-token>

for example

pictobot configure eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL3BpY3RvZ3JhcGguaW8iLCJpYXQiOjE0NjcwMDk2MTgsImp0aSI6IjJjMGIxNzI3LWRiOTUtNDZhYS05YmJjLWM3YWNmODZiMWE4OSIsImF1ZCI6InByb2plY3R8OWI3MjhjYTgtOTE3Zi00ZTk1LWJhNmUtNGEyMDhhY2M3OGYyIiwic2NvcGVzIjp7InNuYXBzaG90cyI6eyJhY3Rpb25zIjpbImNyZWF0ZSJdfX19.dVV1LxVAiSFxwd2qp9c9rKAks9lW5gdR4xhtUEPs

Capturing and sending snapshots

To automatically capture and upload snapshots to your project, just run the pictobot with the following command

pictobot crawl <your-web-URL> <event-identifier>

some examples are as shown below. <event-identifier> could be anything that is tied to the snapshot generation, that makes sense to your internal CI/CD process

pictobot crawl http://getbootstrap.com release/0.9

pictobot crawl https://mysimpleapplication.com build/200

If you would like more information or help, please contact us at support@pictograph.io