PCUI Manual
Installation method
Operating environment
The following environment is necessary to execute pcui.
・Ruby 2.X or higher
・rest-client
・rb-readline
Please install the library with the gem command etc.
(Example) gem install rest-client
Pcui installation
Please get pcui from GitHub (https://github.com/fujitsu-pio/pcui) and place it in an arbitrary folder.Pcui works only with \"pcui.rb \".
Run pcui
Please execute like
・ ruby pcui.rb
on the directory where \"pcui.rb\" resides.
Login to Cell
When starting pcui for the first time, you need to enter the following four pieces of information.
1)In this session, choosing whether to keep the log
2)URL of cell to login
3)Login account
4)Login password
Commands available in Cell mode
Immediately after logging in with pcui, the user is at the top level of Cell. The commands available in Cell mode are as follows.
| username | Display the login account for this session. |
| token | Display the token for this session. |
| pwd | Display the current work location in URL format. |
| ls | Display assets in detailed format. |
| sl | Display assets in simplified format. |
| extcell | Display information on external cells that can be viewed in this session. |
| relation | Display information on relationships that can be viewed in this session. |
| role | Display information on roles that can be viewed in this session. |
| extrole | Display information on external roles that can be viewed in this session. |
| account | Display information on accounts that can be viewed in this session. |
| rcvmessage | Display received messages that can be viewed in this session. |
| sntmessage | Display sent messages that can be viewed in this session. |
| cd {Box} | Move to any Box under the current Cell. As a result, pcui switches from Cell mode to Box mode. For the commands that can be used in Box mode, refer to \"Box Usable Commands in Box Mode\". |
| mk {Box} | create a new Box. |
| acl | Displays the currently set privilege information. |
| rm {Box} | Delete the Box. It can not be deleted if there are assets in Box or when Box is linked with a role etc. |
| help(?) | Display a list of commands available in this mode. |
| quit(q) | Quit pcui. |
Commands available in Box mode
Commands available in Box mode are as follows.
| pwd | Display the current work location in URL format. |
| ls | Display assets in detailed format. |
| sl | Display assets in simplified format. |
| meta | Displays the metadata of Box. |
| url | Displays the URL of the Box. |
| cd .. | It switches from Box mode to Cell mode. |
| put {Path} | Upload any assets in the user's local environment to the current Box.The local environment is currently based on the current directory where pcui is running. |
| get {File} | Download any assets of the current Box to the user's local environment.The local environment is currently based on the current directory where pcui is running. |
| rm {File} | Deletes the asset specified by the current Box. |
| help(?) | "Display a list of commands available in this mode. |
| quit(q) | Quit pcui. |
Files generat by pcui
Pcui generates the following files in the current directory at the time of execution from the viewpoint of convenience and evidence.
- logfile
- Connection information file
When answering yes to the question as to whether to leave the operation log when starting pcui, pcui outputs the log file with the name \"pcui-yyyymmdd.log\".In the log file, the command executed by the user in the session and its response are described.
If there is a log file of the current day, the session log within the day is added to the end of the existing log file.
Considering that the user repeatedly connects to the same Cell, pcui stores up to five URLs of successfully connected cells in the \"pcui.conf \" file.For next and subsequent connections, you can omit the url input by selecting the number assigned to each url.However, login account and password can not be omitted.If there are 5 or more connected urls, delete the information from the old url.
Since this connection information file is in JSON format, it is possible for users to register urls in advance or move to another environment.
Notes on using pcui
- Display command execution result
- Regarding setting of authority etc
The result of executing the command in each mode of pcui is
\"# Accessing http: //personium.demo/cell1/__ctl/Box\"
As shown in, it is displayed as a line appended with #.
Pcui, current status, access authority It does not have the function to operate such as.If an error related to access authority etc. occurs as a result of the command execution, execute the API separately or execute the authority setting tool that can operate the access authority such as UnitManager.
Uninstall pcui
Pcui does not have assets other than the pcui set obtained with GitHub and the \"file generated by pcui\". When uninstalling, delete the pcui main body and the file generated by pcui.
