|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: oputil |
| 4 | +--- |
| 5 | +## The oputil CLI |
| 6 | +ENiGMA½ comes with `oputil.js` henceforth known as `oputil`, a command line interface (CLI) tool for sysops to perform general system and user administration. You likely used oputil to do the initial ENiGMA configuration. |
| 7 | + |
| 8 | +Let's look the main help output as per this writing: |
| 9 | + |
| 10 | +``` |
| 11 | +usage: optutil.js [--version] [--help] |
| 12 | + <command> [<args>] |
| 13 | +
|
| 14 | +global args: |
| 15 | + -c, --config PATH specify config path (./config/) |
| 16 | + -n, --no-prompt assume defaults/don't prompt for input where possible |
| 17 | +
|
| 18 | +commands: |
| 19 | + user user utilities |
| 20 | + config config file management |
| 21 | + fb file base management |
| 22 | + mb message base management |
| 23 | +``` |
| 24 | + |
| 25 | +Commands break up operations by groups. Type `./oputil.js <command> --help` for additional help on a particular command. The next sections will describe them. |
| 26 | + |
| 27 | +## User |
| 28 | +``` |
| 29 | +usage: optutil.js user <action> [<args>] |
| 30 | +
|
| 31 | +actions: |
| 32 | + pw USERNAME PASSWORD set password to PASSWORD for USERNAME |
| 33 | + rm USERNAME permanantely removes USERNAME user from system |
| 34 | + activate USERNAME sets USERNAME's status to active |
| 35 | + deactivate USERNAME sets USERNAME's status to deactive |
| 36 | + disable USERNAME sets USERNAME's status to disabled |
| 37 | + group USERNAME [+|-]GROUP adds (+) or removes (-) USERNAME from GROUP |
| 38 | +``` |
| 39 | + |
| 40 | +| Action | Description | Examples | Aliases | |
| 41 | +|-----------|-------------------|---------------------------------------|-----------| |
| 42 | +| `pw` | Set password | `./oputil.js user pw joeuser s3cr37` | `pass`, `passwd`, `password` | |
| 43 | +| `rm` | Removes user | `./oputil.js user del joeuser` | `remove`, `del`, `delete` | |
| 44 | +| `activate` | Activates user | `./oputil.js user activate joeuser` | N/A | |
| 45 | +| `deactivate` | Deactivates user | `./oputil.js user deactivate joeuser` | N/A | |
| 46 | +| `disable` | Disables user (user will not be able to login) | `./oputil.js user disable joeuser` | N/A | |
| 47 | +| `group` | Modifies users group membership | Add to group: `./oputil.js user group joeuser +derp`<br/>Remove from group: `./oputil.js user group joeuser -derp` | N/A | |
0 commit comments