Skip to content
This repository

VuzitCL – Vuzit Command Line

VuzitCL is a command line program for the Web Services Library . It was created for developers and non-developers to be able to automate the upload, viewing and deletion of documents from their Vuzit web account.

INSTALL

Installation is as easy as copying a file to your computer. Just download the VuzitCL application for your operating system. Here are the instructions:

Windows

  1. Download the VuzitCL-x.×.x_win32.zip zip archive
  2. Extract the vuzitcl.exe file to somewhere on your Windows System PATH

Linux

  1. Download the VuzitCL-x.×.x_linux32.zip zip archive.
  2. Extract the vuzitcl executable and drop it into your system PATH use as /usr/bin or /usr/local/bin (you can run ‘echo $PATH’ to figure that out)

OPTIONS

When you run VuzitCL without any options it will give you the list of options seen below. Several examples of how to use these commands is listed in the later sections.


VuzitCL - Vuzit Command Line
Usage: vuzitcl COMMAND -k PUBLIC_KEY,PRIVATE_KEY [OPTIONS]

Type 'vuzitcl help <command>' for help on a specific command.

Available commands:

  delete
  load
  upload
  search
  help

UPLOAD EXAMPLES

Below is an example of how to upload a file to Vuzit. Replace PUBLIC_KEY and PRIVATE_KEY with your personal Vuzit developer public and private keys respectively. Notice the comma (“,”) between the two keys. You can sign up to get your keys from here.


vuzitcl upload -k PUBLIC_KEY,PRIVATE_KEY "c:/temp/test.pdf"

The output of that command if successful is below.


UPLOADED: abc123

The “abc123” is an example of the document ID. The ID is the unique identifier for the document in the Vuzit document system. You can use this ID to load or delete the document later.

Below is the same example of how to upload a file to Vuzit but to make the file public (using the -p flag).


vuzitcl -k PUBLIC_KEY,PRIVATE_KEY -u "c:/temp/test.pdf" -p

LOAD EXAMPLE

Below is an example of how to load the data from a document. In this example we’ll use that made up “abc123” document ID.


vuzitcl upload -p -k PUBLIC_KEY,PRIVATE_KEY "c:/temp/test.pdf"

This is some sample output that you’ll see:


LOADED: abc123
title: Some sample title
subject: Sample subject
pages: 13
width: 595
height: 842
size: 29730
status: 4

SEARCH EXAMPLE

Below is an example of how to search for documents within an account. In this example we’ll search for the term “john smith” and limit the results to the first 3.


vuzitcl search -k PUBLIC_KEY,PRIVATE_KEY -q "john smith" -l 3

The output will be virtually the same as that from the load example above except that 3 documents will be returned along with excerpts.

DELETE EXAMPLE

Below is an example of how to delete a document. In this example we’ll use the “abc123” document ID we created earlier.


vuzitcl delete -k PUBLIC_KEY,PRIVATE_KEY abc123

This is some sample output that you’ll see if successful:


DELETED: abc123

USING WITH YOUR PROGRAMMING LANGUAGE

Vuzit already has support for programming languages like PHP, Ruby, MS .NET and Java so it’s recommended that you use these. However if your language is not currently supported then you can use VuzitCL to handle it.

Below are a few libraries that allow programmers to run external applications.

SPECIAL THANKS

Thanks to Erik Veenstra for his RubyScript2Exe
which made it possible to write this application natively for Windows and Linux without the need for a Ruby interpreter.

LICENSE

Copyright © 2009-2010 Brent Matzelle, Vuzit LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.