|
|
|
# Installing the `webis` command
|
|
|
|
|
|
|
|
Follow the instructions in this guide to install the `webis` command on your own machine.
|
|
|
|
|
|
|
|
## Preparation: installing dependencies
|
|
|
|
|
|
|
|
### Linux / Mac
|
|
|
|
|
|
|
|
- Install `git` (at least version 1.7) and `python` (at least either version 2.7 or version 3.2) using your usual method for installing system packages. Depending on your operating system / distribution, these may already be installed by default. Open a terminal and run `git --version` or `python --version` to check.
|
|
|
|
|
|
|
|
### Windows
|
|
|
|
|
|
|
|
- Go to [cygwin.com](https://www.cygwin.com) and download and install the appropriate `cygwin` distribution for your operating system (either the 32-bit or 64-bit version)
|
|
|
|
- During installation, make sure that the `bash`, `git`, `python` and `openssh` packages are selected
|
|
|
|
- For the remainder of this guide, use the cygwin `bash` shell to enter all commands; this will likely be called "Cygwin Terminal" or similar in your start menu
|
|
|
|
|
|
|
|
## Installing and updating the `webis` command
|
|
|
|
|
|
|
|
### Multi-user machines (Linux/Mac only)
|
|
|
|
|
|
|
|
If you have more than one user account on your machine, and multiple accounts will use the `webis` command, you need to install it using the following procedure: (there "probably" is no equivalent way to do this on Windows)
|
|
|
|
|
|
|
|
- Clone the `code-webis-cmd` git repository into a system-wide directory:
|
|
|
|
```shell-session
|
|
|
|
$ sudo git clone https://webis16.medien.uni-weimar.de/gitlab/code-generic/code-webis-cmd.git /usr/local/share/webis-cmd
|
|
|
|
```
|
|
|
|
|
|
|
|
- Run the installation script:
|
|
|
|
```shell-session
|
|
|
|
$ sudo /usr/local/share/webis-cmd/tools/core/install.sh
|
|
|
|
```
|
|
|
|
|
|
|
|
- Now, you should have the `webis` command on your PATH:
|
|
|
|
```shell-session
|
|
|
|
$ webis -h
|
|
|
|
usage: webis [-h] <command> ...
|
|
|
|
positional arguments:
|
|
|
|
<command> Available commands:
|
|
|
|
betaweb (bw) High level scripts for betaweb, e.g. hadoop management.
|
|
|
|
core (co) Core functions of webis command.
|
|
|
|
git Helper scripts for working with the webis Git server and
|
|
|
|
GitLab instance.
|
|
|
|
...
|
|
|
|
```
|
|
|
|
|
|
|
|
- To update to the newest version, run the `core/update` command as root:
|
|
|
|
```shell-session
|
|
|
|
$ sudo webis core update
|
|
|
|
```
|
|
|
|
|
|
|
|
### Single-user machines
|
|
|
|
|
|
|
|
If you have only one user account, you don't need to clone the repository to a system-wide folder, any location (e.g. in your HOME directory) will do, for example:
|
|
|
|
|
|
|
|
```shell-session
|
|
|
|
$ git clone https://webis16.medien.uni-weimar.de/gitlab/code-generic/code-webis-cmd.git ~/webis-cmd
|
|
|
|
$ sudo ~/webis-cmd/tools/core/install.sh
|
|
|
|
```
|
|
|
|
|
|
|
|
In this case, you don't need sudo to update:
|
|
|
|
```shell-session
|
|
|
|
$ webis core update
|
|
|
|
```
|
|
|
|
|
|
|
|
Note: if you're on Windows, the `install.sh` script will probably not work as intended. You can still use the `webis` command for most tasks, if you can make sure that the `webis.py` driver script is on your system PATH. |
|
|
\ No newline at end of file |
