Skip to content
This repository has been archived by the owner on May 23, 2019. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolewhite committed Aug 15, 2015
1 parent 21e2d14 commit d562946
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down
Binary file added screenshots/autocomplete-matching.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/output.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d562946

Please sign in to comment.