diff --git a/README.md b/README.md index 6f965ee..87d2536 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,10 @@ A Command Line Interface for Neo4j's Cypher Query Language. ## Install -### Stable Release from PyPI - ``` $ pip install cycli ``` -### Latest Development Release - -``` -$ git clone https://github.com/nicolewhite/cycli.git -$ sudo python cycli/setup.py install -``` - ## Start To start, simply execute `cycli` from your terminal. @@ -34,6 +25,17 @@ $ cycli -u username You will then be prompted to enter your password. For more options, execute `cycli --help`. +## Options + +* `-v`, `--version`: Show cycli version and exit. +* `-h`, `--host`: The host address of Neo4j. +* `-P`, `--port`: The port number on which Neo4j is listening. +* `-u`, `--username`: Username for Neo4j authentication. +* `-p`, `--password`: Password for Neo4j authentication. +* `-t`, `--timeout`: Set a global socket timeout for queries. +* `-l`, `--logfile`: Log every query and its results to a file. +* `-f`, `--filename`: Execute semicolon-separated Cypher queries from a file. + ## Features ### Autocomplete @@ -58,6 +60,12 @@ functions, and predicates. ![cypher](screenshots/autocomplete-cypher.png) +#### Opening Characters + +If you type `(`, `[`, `{`, `"`, or `'`, a matching closing character is automatically placed to the right of your cursor. + +![matching](screenshots/autocomplete-matching.png) + ### Syntax Highlighting Catch syntax errors with the built-in syntax highlighting. The colors were chosen to emulate the syntax highlighting diff --git a/screenshots/autocomplete-matching.png b/screenshots/autocomplete-matching.png new file mode 100644 index 0000000..27b4318 Binary files /dev/null and b/screenshots/autocomplete-matching.png differ diff --git a/screenshots/output.gif b/screenshots/output.gif index af6617b..a3f920f 100644 Binary files a/screenshots/output.gif and b/screenshots/output.gif differ