go/ferret
go/ferret
1
0
Fork 0
mirror of https://github.com/MontFerret/ferret.git synced 2024-12-12 11:15:14 +02:00
Code Issues Releases Activity

Updated README

Browse Source
This commit is contained in:
Tim Voronov 2018-10-04 22:16:03 -04:00
parent abec033649
commit f083bfdc4c
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -69,7 +69,7 @@ For query syntax, you may go to [ArangoDB web site](https://docs.arangodb.com/3.
* Chrome or Docker (optional)
```sh
make install && make compile
go get github.com/MontFerret/ferret
```
You can use your local copy of Google Chrome / Chromium, but for ease of use it's recommended to run it inside a Docker container:
@ -91,7 +91,7 @@ chrome.exe --remote-debugging-port=9222
If you want to play with ```fql``` and check its syntax, you can run CLI with the following commands:
```
go run main.go
ferret
```
```ferret``` will run in REPL mode.
@ -112,15 +112,15 @@ Please use `Ctrl-D` to exit this program.
If you want to execute a query stored in a file, just pass a file name:
```
go run main.go ./docs/examples/hackernews.fql
ferret ./docs/examples/hackernews.fql
```
```
cat ./docs/examples/hackernews.fql | go run main.go
cat ./docs/examples/hackernews.fql | ferret
```
```
go run main.go < ./docs/examples/hackernews.fql
ferret < ./docs/examples/hackernews.fql
```
@ -133,7 +133,7 @@ First, you need to make sure that you launched Chrome with ```remote-debugging-p
Second, you need to pass the address to ```ferret``` CLI.
```
go run main.go --cdp http://127.0.0.1:9222
ferret --cdp http://127.0.0.1:9222
```
**NOTE:** By default, ```ferret``` will try to use this local address as a default one, so it makes sense to explicitly pass the parameter only in case of either different port number or remote address.
@ -141,7 +141,7 @@ go run main.go --cdp http://127.0.0.1:9222
Alternatively, you can tell CLI to launch Chrome for you.
```shell
go run main.go --cdp-launch
ferret --cdp-launch
```
**NOTE:** Launch command is currently broken on MacOS.