Introduction

This manual describes how to install and set up eccenca Corporate Memory Control (cmemc), the eccenca Corporate Memory command line client.


cmemc is intended for system administrators and Linked Data Expert, who wants to automate / remote control activities on Corporate Memory.

To use this manual, cmemc users should have basic knowledge on command line interfaces, terminal usage and config file creation and editing.

This document covers installation and basic usage pattern of cmemc and is not intended to be complete in terms of being a reference for all available options and commands. However, cmemc provides detailed documentation for users via the --help option.

About

cmemc is the eccenca Corporate Memory Command Line Interface (CLI). It is developed in python and build and delivered as a stand alone single binary for Linux and Windows.

Main features of cmemc include:

  • List, import, export, delete and open graphs.
  • List, import, export, create and delete projects.
  • List and execute local as well as remote SPARQL queries.
  • List, execute, open or inspect workflows.
  • Import and export the workspace.

Scope of delivery

The cmemc release package consists of the following files:

  • cmemc - the Linux ELF 64-bit LSB executable (x86-64, version 1 (SYSV), dynamically linked), tested with Ubuntu
  • cmemc-rhel - the Linux ELF 64-bit LSB executable (x86-64, version 1 (SYSV), dynamically linked), tested with RHEL
  • cmemc-macosx - the Mach-O 64-bit executable (x86_64), tested with macOS Mojave
  • cmemc.exe  - the PE32+ executable (console, x86-64), for Microsoft Windows, tested with Windows 10
  • cmemc_vXX.YY_SystemManual.pdf  - the PDF manual

Installation

Since cmemc is a stand alone binary, installation is not needed. cmemc can be started from a local path and also from a central binary path, such as /usr/local/bin . The only needed installation activity is to copy the binary to a path on your system which is in the PATH variable.

Linux installation

As a first step, output the content of the PATH variable in order to determine, the path to use:

$ echo $PATH
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
BASH

Then unzip the distribution package and copy the binary to an acceptable path (in this example: `/usr/local/bin`)

XXX depends on your actual version!

$ unzip cmemc-vXXX.zip
$ cp cmemc-vXXX/cmemc /usr/local/bin
$ chmod +x /usr/local/bin/cmemc
BASH

Finally, test your installation.

XXX depends on your actual version!

$ cmemc --version
cmemc, version XXX
BASH

macOS installation

Copy Deployment

Installation on macOS is similar to the installation on Linux. Just copy the unpacked cmemc-macosx binary to a directory in your PATH (renaming it to `cmemc`).
Since zsh is the default shell on MacOS, use the zsh completion as described above.

Homebrew-based Deployment

In case you are using homebrew as your package manager, you can also use the official eccenca tap to install cmemc on you mac:

$ brew install eccenca/main/cmemc
==> Installing cmemc from eccenca/main
==> Downloading https://releases.eccenca.com/cmemc/cmemc-v20.06.tgz
######################################################################## 100.0%
🍺  /usr/local/Cellar/cmemc/20.06: 4 files, 7.5MB, built in 2 seconds
BASH

Windows installation

The installation for Windows is similar. As a first step, unzip the distribution file ( cmemc-vXXX.zip  ), then open cmd.exe  and go to the directory where the cmemc files are extracted. Then you can start cmemc.exe  .

XXX depends on your actual version!

Example execution of cmemc under Windows

Configuration

Once you "installed" cmemc, you maybe want to configure a connection with a config file or learn how to use environment variables to control cmemc.