Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spalger committed Oct 27, 2016
1 parent 1808c64 commit e4b2764
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Sense
=====
# HEADS UP: This repo is deprecated. Sense is now included as Console in Kibana 5.0. File issues over at [elastic/kibana](https://www.github.com/elastic/kibana)

## Sense

A JSON aware developer's interface to Elasticsearch. Comes with handy machinery such as syntax highlighting, API suggestions,
formatting and code folding.

Installation
-----
### Installation

Sense is a Kibana app. To get up and running you will first need to download Kibana and install as instructed [here](https://www.elastic.co/downloads/kibana).
Once Kibana is installed, you can simply install Sense running the following command from your Kibana folder:
Expand All @@ -25,43 +25,42 @@ Sense should be available on http://localhost:5601/app/sense (assuming Kibana de
For more information and advanced setting please see the [documentation](https://www.elastic.co/guide/en/sense/current/installing.html).


Screenshots
-----
### Screenshots


### Handy API suggestions
#### Handy API suggestions

Sense offers handy contextual suggestion to the Elasticsearch API.

<img src="https://github.com/elastic/sense/raw/master/docs/images/readme_api_suggestions.png" width="400px" title="API Suggestions">

### Format validation
#### Format validation

Sometimes it is hard to find that little missing comma. Sense automatically highlights and explains invalid input.

<img src="https://github.com/elastic/sense/raw/master/docs/images/readme_errors.png" width="400px" title="Format validation">

### Scope collapsing
#### Scope collapsing

Working on a big JSON query can be distracting. Using the mouse or via a handy keyboard shortcut (Ctrl/Cmd+Option+0)
, Sense allows you to focus on a sub section and fold others away.

<img src="https://github.com/elastic/sense/raw/master/docs/images/readme_scope_collapsing.png" width="400px" title="Folding">

### Auto formatting
#### Auto formatting

Type your commands however you want and let Sense format them for you.

<img src="https://github.com/elastic/sense/raw/master/docs/images/readme_auto_formatting_mix.png" width="400px" title="Auto formatting">

### Submit multiple requests at once
#### Submit multiple requests at once

When testing or trying things out you frequently need to repeat the same sequence of commands.
Just write them all in Sense, select and submit multiple requests to Elasticsearch.

<img src="https://github.com/elastic/sense/raw/master/docs/images/readme_multiple_requests.png" width="400px" title="Multiple Requests">

### Copy and Paste cURL commands
#### Copy and Paste cURL commands

Once done, you can copy one or more requests as cURL commands (and of course paste them back)

Expand All @@ -82,10 +81,7 @@ curl -XPUT "http://localhost:9200/website/blog/123" -d'
}'
```



Documentation
--------
### Documentation

Visit [elastic.co](https://www.elastic.co/guide/en/sense/current/index.html) for the full documentation.

Expand Down

0 comments on commit e4b2764

Please sign in to comment.