How to install the xPack Docus Mock binaries
Overview
The xPack Docus Mock can be installed automatically, via xpm (the
recommended method), or manually, by downloading and unpacking one of the
portable archives.
- Windows
- macOS
- GNU/Linux
Easy install
The easiest way to install Docus Mock is by using the binary xPack, available as
@xpack-dev-tools/docus-mock
from the npmjs.com registry.
Prerequisites
The only requirement is a recent xpm, which is a portable Node.js command line application. To install it, follow the instructions from the xpm install page.
Install
With xpm available, installing the latest version of the package is quite easy:
cd my-project
xpm init # Only at first use.
xpm install @xpack-dev-tools/docus-mock@latest --verbose
This command will always install the latest available version,
in the global xPacks store, which is a platform dependent folder
(check the output of the xpm command for the actual folder used on
your platform).
The install location can be configured using the
XPACKS_STORE_FOLDER environment variable; for more details please check the
xpm folders page.
The archive content is unpacked into a folder
named .content. On some platforms
this might be hidden for normal browsing, and require
separate options (like ls -A) or, in file browsers, to enable
settings like Show Hidden Files.
Uninstall
To remove the links from the current project:
cd my-project
xpm uninstall @xpack-dev-tools/docus-mock
To completely remove the package from the global store:
xpm uninstall --global @xpack-dev-tools/docus-mock --verbose
Test
To check if the xpm installed Docus Mock starts, use something like:
C:\>%USERPROFILE%\AppData\Roaming\xPacks\@xpack-dev-tools\docus-mock\1.11.0-1.1\.content\bin\docus-mock.exe --version
1.11.0
Manual install
For all platforms, the xPack Docus Mock binaries are released as portable archives that can be installed in any location.
The archives can be downloaded from the GitHub Releases page.
Download
The Windows versions of xPack Docus Mock are packed as ZIP files. Download the latest version named like:
xpack-docus-mock-1.11.0-1-win32-x64.zip
In case you wonder where the suffix comes
from, it is exactly the Node.js process.platform and process.arch.
The win32 part is confusing, but we have to leave with it.
Unpack
To manually install the xPack Docus Mock,
unpack the archive and copy it into the
%USERPROFILE%\AppData\Roaming\xPacks\docus-mock
(for example C:\Users\ilg\AppData\Roaming\xPacks\docus-mock) folder;
according to Microsoft, AppData\Roaming is the recommended location for
installing user specific packages.
For manual installs, the recommended
install location is slightly different from the xpm install folders,
which use the scope (like @xpack-dev-tools) to group different tools,
and .content to store the unpacked archive.
Test
To check if the manually installed Docus Mock starts, use something like:
C:\>%USERPROFILE%\AppData\Roaming\xPacks\docus-mock\xpack-docus-mock-1.11.0-1\bin\docus-mock.exe --version
1.11.0
Easy install
The easiest way to install Docus Mock is by using the binary xPack, available as
@xpack-dev-tools/docus-mock
from the npmjs.com registry.
Prerequisites
The only requirement is a recent xpm, which is a portable Node.js command line application. To install it, follow the instructions from the xpm install page.
Install
With xpm available, installing the latest version of the package is quite easy:
cd my-project
xpm init # Only at first use.
xpm install @xpack-dev-tools/docus-mock@latest --verbose
This command will always install the latest available version,
in the global xPacks store, which is a platform dependent folder
(check the output of the xpm command for the actual folder used on
your platform).
The install location can be configured using the
XPACKS_STORE_FOLDER environment variable; for more details please check the
xpm folders page.
The archive content is unpacked into a folder
named .content. On some platforms
this might be hidden for normal browsing, and require
separate options (like ls -A) or, in file browsers, to enable
settings like Show Hidden Files.
Uninstall
To remove the links from the current project:
cd my-project
xpm uninstall @xpack-dev-tools/docus-mock
To completely remove the package from the global store:
xpm uninstall --global @xpack-dev-tools/docus-mock --verbose
Test
To check if the xpm installed Docus Mock starts, use something like:
$ ~/.local/xPacks/@xpack-dev-tools/docus-mock/1.11.0-1.1/.content/bin/docus-mock --version
1.11.0
Manual install
For all platforms, the xPack Docus Mock binaries are released as portable archives that can be installed in any location.
The archives can be downloaded from the GitHub Releases page.
Download
The macOS versions of xPack Docus Mock
are packed as .tar.gz archives.
Download the latest version named like:
xpack-docus-mock-1.11.0-1-darwin-x64.tar.gzxpack-docus-mock-1.11.0-1-darwin-arm64.tar.gz
Unpack
To manually install the xPack Docus Mock, unpack the archive and move it to ~/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1:
mkdir -p ~/.local/xPacks/docus-mock
cd ~/.local/xPacks/docus-mock
tar xvf ~/Downloads/xpack-docus-mock-1.11.0-1-darwin-x64.tar.gz
chmod -R -w xpack-docus-mock-1.11.0-1
For manual installs, the recommended install location is different from the xpm install folders.
The result is a structure like:
$ tree -L 2 /Users/ilg/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1
/Users/ilg/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1/
├── README.md
├── bin
│ └── docus-mock
└── distro-info
├── CHANGELOG.md
├── licenses
├── patches
└── scripts
5 directories, 3 files
Test
To check if the manually installed Docus Mock starts, use something like:
$ ~/.local/xPacks/docus-mock/1.11.0-1/bin/docus-mock --version
1.11.0
Easy install
The easiest way to install Docus Mock is by using the binary xPack, available as
@xpack-dev-tools/docus-mock
from the npmjs.com registry.
Prerequisites
The only requirement is a recent xpm, which is a portable Node.js command line application. To install it, follow the instructions from the xpm install page.
Install
With xpm available, installing the latest version of the package is quite easy:
cd my-project
xpm init # Only at first use.
xpm install @xpack-dev-tools/docus-mock@latest --verbose
This command will always install the latest available version,
in the global xPacks store, which is a platform dependent folder
(check the output of the xpm command for the actual folder used on
your platform).
The install location can be configured using the
XPACKS_STORE_FOLDER environment variable; for more details please check the
xpm folders page.
The archive content is unpacked into a folder
named .content. On some platforms
this might be hidden for normal browsing, and require
separate options (like ls -A) or, in file browsers, to enable
settings like Show Hidden Files.
Uninstall
To remove the links from the current project:
cd my-project
xpm uninstall @xpack-dev-tools/docus-mock
To completely remove the package from the global store:
xpm uninstall --global @xpack-dev-tools/docus-mock --verbose
Test
To check if the xpm installed Docus Mock starts, use something like:
$ ~/.local/xPacks/@xpack-dev-tools/docus-mock/1.11.0-1.1/.content/bin/docus-mock --version
1.11.0
Manual install
For all platforms, the xPack Docus Mock binaries are released as portable archives that can be installed in any location.
The archives can be downloaded from the GitHub Releases page.
Download
The GNU/Linux versions of xPack Docus Mock
are packed as .tar.gz archives.
Download the latest version named like:
xpack-docus-mock-1.11.0-1-linux-x64.tar.gzxpack-docus-mock-1.11.0-1-linux-arm.tar.gzxpack-docus-mock-1.11.0-1-linux-arm64.tar.gz
As the name implies, these are GNU/Linux tar.gz archives; they were build on
Ubuntu, but can be executed on most recent GNU/Linux distributions.
Unpack
To manually install the xPack Docus Mock, unpack the archive and move it to ~/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1:
mkdir -p ~/.local/xPacks/docus-mock
cd ~/.local/xPacks/docus-mock
tar xvf ~/Downloads/xpack-docus-mock-1.11.0-1-linux-x64.tar.gz
chmod -R -w xpack-docus-mock-1.11.0-1
For manual installs, the recommended
install location is slightly different from the xpm install folders,
which use the scope (like @xpack-dev-tools) to group different tools,
and .content to store the unpacked archive."
$ tree -L 2 /home/ilg/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1
/home/ilg/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1/
├── bin
│ └── docus-mock
├── distro-info
│ ├── CHANGELOG.md
│ ├── licenses
│ ├── patches
│ └── scripts
└── README.md
5 directories, 3 files
Test
To check if the manually installed Docus Mock starts, use something like:
$ ~/.local/xPacks/docus-mock/xpack-docus-mock-1.11.0-1/bin/docus-mock --version
1.11.0
Testing
TODO