documentdb-cli
Cross platform command line interface for DocumentDB
NOTE: All Pull-Requests must be made into the dev
branch.
Installation
You can install the documentdb-cli npm package.
npm install -g documentdb-cli
If you're more adventurous and like to live on the edge then you can install development version as follows:
git clone https://github.com/hasankhan/documentdb-clicd documentdb-cligit checkout devnpm install -g
Get Started
To get the list of all parameters type 'documentdb -h'
Usage: documentdb [options] Options: -h, --help output usage information -V, --version output the version number -s, --server <server> Server to conect to -k, --masterKey <key> The master key to use
To connect to a DocumentDB instance invoke documentdb as follows
documentdb -s https://abcdef.documents.azure.com -k u1d0wTrlTWPVoA== -d mydatabase -l mycollection
You will get a prompt as follows:
Connecting to https://abcdef.documents.azure.com...done documentdb-cli version 0.0.0Enter ".help"
To get the list of all commands use the '.help' command
documentdb> .help command description----------------- ---------------------------------------.help Shows this message.databases Lists all the databases.collections Lists all the collections.storedprocs Lists all the stored procedures.conflicts Lists all the conflicts.triggers Lists all the triggers.functions Lists all the user defined functions.permissions USER Lists all the permissions.attachments DOC Lists all the attachments.users Lists all the users.use db|coll ID Switches current database or collection.read FILENAME Execute commands in a file.quit Exit the cli
To exit the cli use the '.quit' command
documentdb> .quit