2023-11-20 09:05:07 -07:00
|
|
|
# -*- mode: org; coding: utf-8; -*-
|
|
|
|
|
|
|
|
|
|
#+TITLE: README for Msg
|
|
|
|
|
|
2023-11-25 10:38:14 -07:00
|
|
|
* Requirements
|
|
|
|
|
- wget
|
|
|
|
|
- qemu
|
|
|
|
|
- autotools
|
|
|
|
|
- guile (or guile-next)
|
2023-11-30 05:32:45 -07:00
|
|
|
- texinfo
|
2023-11-25 10:38:14 -07:00
|
|
|
|
|
|
|
|
These can be installed by running:
|
|
|
|
|
#+begin_src sh
|
2023-11-30 05:32:45 -07:00
|
|
|
brew install autoconf automake libtool wget qemu guile texinfo
|
2023-11-25 10:38:14 -07:00
|
|
|
#+end_src
|
|
|
|
|
|
|
|
|
|
* Installation
|
|
|
|
|
1. First clone this repository with:
|
|
|
|
|
#+begin_src sh
|
|
|
|
|
git clone https://pagure.io/MSG/msg-cli.git
|
|
|
|
|
cd msg-cli
|
|
|
|
|
#+end_src
|
|
|
|
|
|
|
|
|
|
2. Build and install the cli using:
|
|
|
|
|
#+begin_src sh
|
2023-11-30 05:32:45 -07:00
|
|
|
autoreconf -vif && ./configure && make && sudo make install
|
2023-11-25 10:38:14 -07:00
|
|
|
#+end_src
|
|
|
|
|
|
|
|
|
|
3. Make sure to add the correct env vars set for guile/MSG (may need to adjust if using the guile homebrew tap)
|
|
|
|
|
#+begin_src sh
|
|
|
|
|
export GUILE_LOAD_PATH=/usr/local/share/guile/site/3.0/
|
|
|
|
|
export GUILE_LOAD_COMPILED_PATH=/usr/local/lib/guile/3.0/site-ccache/
|
|
|
|
|
export GUILE_SYSTEM_EXTENSIONS_PATH=/usr/local/lib/guile/3.0/extensions
|
|
|
|
|
export PATH=/usr/local/bin:$PATH
|
|
|
|
|
#+end_src
|
|
|
|
|
|
|
|
|
|
* Usage
|
|
|
|
|
- msg machine (command)
|
|
|
|
|
- init: initializes a new MSG instance
|
|
|
|
|
- reinit: reinitializes an MSG instance (is destructive!)
|
|
|
|
|
- start: starts the initialized MSG instance
|
|
|
|
|
- stop: stops the running instance
|
|
|
|
|
- msg shell
|
|
|
|
|
- Creates an ssh connection to the running instance
|
