We're currently supporting IntelliJ 2016.3.
Any future versions will be supported as well.
We are currently supporting individual code for each person only.
A license can be used for one person on multiple computers.
You can purchase multiple licenses for each person in your team.
When you try to use Iedis, it will give you a notification to activate, just click the link to enter your license to activate.
Network is required to activate the plugin, make sure that you can connect to https://www.codesmagic.com.
Iedis lua debugger is based on
Lua plugin, so that you have to install it to use Iedis debugger.
You'll be asked to install Lua plugin after you install Iedis or you can install it manually later.
Some features are out of box after you install both plugins, redis function auto-completion, command auto-completion, documentation, and so forth.
You have to setup a Run/Debug configuration before Run/Debug a Redis lua script.
Right Click a script file or using
Context Menu to create a configuration quickly.
You must be familiar with this if you're a skilled IntelliJ user.
You can do many things during configuration, choose a Redis Server to run the script, predefine some KEYS or ARGV, choose debug mode, and so forth.
You can skip defining KEYS or ARGV if you want to, Iedis will ask you to provide them when you try to run the scirpt if Iedis determines that KEYS or ARGV are required.
Defined KEYS or ARGV are cached so that you don't need to provide them each time you run the script.
You can do as many things with the debugger as other languages can do in IntelliJ IDEA.
We also introduce a Redis debug console during a debug session, so that you can execute Redis commands to help you debugging.
Some other features are also available in debug console, such as auto-completion, documentation.
Iedis will print the details of commands interaction if you choose
Print redis call detail when step over in debugger in Run/Debug Configuration dialog.
This is pretty useful to determine that how your script affects the data set.
Code evaluation and variable watches are supported while debugging.
A stirng with a single world will be determined as a variable, and Iedis will use
EVAL command. Note: The
EVAL command is executed in a different callframe.
We can use these buttons to manage all your Redis instances in one place.
To add a new Redis Server, we can use the default shortcuts Command + N for Mac and Alt + Insert for Windows.
To edit a Redis Server, we can use the default shortcuts Shift + F6 for both Mac and Windows.
To remove a Redis Server, we can use the default shortcuts Backspace for both Mac and Windows.
Iedis will determine Redis Server mode (Single Instance Mode or Cluster Mode) asynchronously when the tool window is opened or the server configuration is changed.
So we need to refresh the servers if the detecting fails due to server issue (For example, server is stopped). The default shortscuts to refresh Redis Servers are Command + Option + Y for Mac and Ctrl + Alt + Y for Windows.
You can connect to a remote Redis Server with SSH Tunnel in case you need it.
Both password auth and key pairs auth (OpenSSH based) are supported with SSH Tunnel.
All Redis Servers will be present here, so you can work with them together.
All master nodes and slave nodes will be presnet here as well when Iedis determines that Redis is running in cluster mode, then you can with both nodes later.
There are some useful options in the popup menu, such as
Slow Log etc.
To open the popup menu, we can just right click on a Redis Server.
Key Explorer is a big deal to work with keys in both Single Instance Mode and Cluster Mode. We can do almost anything on keys here. Such as View, Edit, Clone etc.
We can open a Key Explorer any time you want and Redis Server mode will be determined on the fly. Redis dbsize will be displayed on the status bar and it will refresh every second.
To open a Key Explorer you can first select a Redis Server, then click the
Open Explorer button.
We can also open a Key Explorer with the shortcuts: Option + ⬇ for Mac and Alt + ⬇ for Windows.
We can search keys by typing some key patterns here and multi key patterns should be separated by new lines.
We can click the
Scan Keys button to search the desired keys or using shortcuts to start the searching:
Command + ↩ for Mac and Ctrl + ↩ for Windows.
This works exactly the same way in both Single Instance Mode and Cluster Mode, Iedis will take care of anything else.
Some convenient actions are available here. Scan More Keys, Add a new Key, Rename a Key, Clone a Key, Switch Database, View Pattern History etc.
All desired keys will be listed here. Each key has a icon to present its type. Some raw information will be displayed on the status bar when a key is selected.
Some useful actions are available in the popup menu. For example, copy the key.
We can view, edit members and values of keys here.
Lanuage Editor will be used to present the values according to the content type of the value which will be determined on the fly.
We can avoid some mistakes while editting the value as syntax inspection will be used with the value.
We integrate Redis commands with IntelliJ as a custom language, then we can have commands and keywords auto-completion, syntax inspection, commands formatting etc.
The console will be available after Redis Server mode is determined.
We can open the console by clicking the
Open Terminal button or use default shortcuts Command + Shift + F10 for Mac and Ctrl + Shift + F10 for Windows.
Iedis executes Redis commands as some kind of scripts, so we can execte multi commands at a time.
Iedis will only execute selected commands if only some commands are selected, otherwise all commands will be exected one by one.
To execte the commands, we can click the
Run Command button or use the shortcuts Command + ↩ for Mac and Ctrl + ↩ for Windows.
We can stop command execution in case we want to terminate a blocking command. To stop the execution, we can click the
Terminate button or use the
shortcuts: Command + F2 for Mac and Ctrl + F2 for Windows.
Commands documentation is available with the console in case you need it.
The documentation will be rendered very quckly as they are offline ones.
The default shortcuts to open the documentation are Ctrl + J for Mac and Ctrl + Q for Windows.
Iedis executes commands one by one, and the result of each command will be present with a tab in the result panel at the bottom of IDE.
Some commands, such as
MONITOR etc, will get a new tab to present the result each time a server message is received.
We even make the result of some frequently used commands much more human readable, such as
CLUSTER NODE etc.
We introduce a console history window as keys explorer does.
We can rerun any commands that has been executed earlier easily.
The default shortcuts to open the documentation are Command + Option + E for Mac and Ctrl + Alt + E for Windows.