Initial commit
[squelch.git] / README
1 SQueLch
2
3 This is a simple console-based SQL client.
4 It is database-agnostic, and should work with any database for which you have a JDBC driver.
5
6 To build it:
7
8   $ mvn clean package
9
10 To run it:
11
12   Add your JDBC jar to your CLASSPATH, then:
13   $ java -jar ./target/squelch-0.1-SNAPSHOT-jar-with-dependencies.jar --help
14
15 For example:
16
17   $ java -jar squelch.jar -u chris -p passwordGoesHere -r postgresql:localhost/cfb
18
19 Note that it's more secure to put your password in a config file instead, for example:
20
21   $ cat >config.properties
22   db.user=chris
23   db.password=passwordGoesHere
24   db.url=postgresql:localhost/cfb
25   ^D
26   $ java -jar squelch.jar --config config.properties
27
28 The code is available under the GNU General Public Licence (GPL) version 3, or (at your option) any later version.
29 See the file COPYING for details.
30
31 *> Chris Jaekl
32 https://www.jaekl.net/chris/
33