Skip to content

Commit 8285eac

Browse files
committed
Add CLI tool
1 parent 7873050 commit 8285eac

File tree

2 files changed

+445
-0
lines changed

2 files changed

+445
-0
lines changed

remoting_client/cli/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Project Title
2+
Command line for ISPConfig remote user REST API using either smart functions or raw methods.
3+
4+
## Getting Started
5+
This tool can be used and packaged stand alone, without ISPConfig itself. It is designed to have as few dependencies as possible.
6+
7+
The script has two main modes: method wrapping and functions. Method wrapping already works nicely, and simply makes properly formatted requests with curl,
8+
making it a handy tool for custom requests, testing, automation and scripting. Functions in turn are combinations of methods and checks that act more like an intelligent tool and does not require the user
9+
to understand JSON.
10+
11+
If you want to script using functions, consider using -q.
12+
13+
Example method:
14+
ispconfig-cli -m login -j credentials.json
15+
{"code":"ok","message":"","response":"dc39619b0ac9694cb85e93d8b3ac8258"}
16+
17+
Example function:
18+
ispconfig-cli -f "dns_a_add example.com. www 192.168.0.2"
19+
DNS zone example.com. has id 1.
20+
DNS A www exists with id 228, updating...
21+
Updated records: 1
22+
23+
The script uses an optional config file, making commands short as above.
24+
25+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for
26+
notes on how to deploy the project on a live system.
27+
28+
### Dependencies
29+
1) jq
30+
2) curl
31+
32+
### Installing
33+
1) Place this script in your path, for example in your ~/bin folder on many distros.
34+
2) Make it executable ```chmod 755 ispconfig-cli```
35+
3) Optionally create a config file in /etc/ispconfig-cli.conf or ~/.ispconfig-cli
36+
37+
## Details on usage
38+
Run the script without arguments for the full list of functionality and config file creation.

0 commit comments

Comments
 (0)