Installation

See installation below separately for the API library and the packager.

API library

There are two ways to install and use the API library: npm and a precompiled distribution.

It doesn't matter which installation you prefer, the usage is similar with the main difference being the lack of import calls and the miletus prefix. In this documentation we will always refer to the library obtained through npm. If you are using the precompiled library, please make sure to always use the miletus prefix for the exposed objects and classes:

Installed from npmPrecompiled library

import { clipboard } from 'miletus';

clipboard.writeText('Hello World!');

miletus.clipoard.writeText('Hello World!');

For a simple example on getting started check out our Your first application guide.

npm

The TypeScript API library can be installed through npm. Keep in mind this is depending on Node.js to be installed on your system. If you are not familiar with Node.js, then you can:

• Use one of the many available resources to get more comfortable with it: Introduction to Node.js
• Use the precompiled distribution instead.

Install by running the following command:

npm install miletus

Note

By using the TypeScript API you will also need to use bundlers such as webpack or browserify to make the code browser compatible.

Precompiled JavaScript distribution

We are making the presumption that you are already familiar with JavaScript and web development in general. If that is not the case, a good place to start is the Getting started with the web series from MDN.

You can access the precompiled JavaScript distribution from:

• the npm build folder
• the dist folder from the direct packager installation

Packager

The packager is available as a separate download in form of an installer or as a VSCode extension.

Direct download - Installer

See the download links for direct installation here. Check the platform specific installation steps and usage below.

When running from the command prompt or terminal, the packager expects 1 parameter: the root folder of your project, where miletus.config.json is.

Windows

Simply run the downloaded Windows installer. The installer offers the option to add the Miletus Packager to the PATH.

Make sure to verify your installation first by calling the packager with the -v parameter. This will print the current MiletusPackager version.

C:\Users\YourUsername\YourProjectPath> MiletusPackager -v

Alternatively if you did not add the packager to the PATH variable, use the packager from the installation folder:

C:\Users\YourUsername\YourInstallationFolderPath\Win64> MiletusPackager -v

You should see the help page being printed.

The usage is similar to above. Instead of the -h parameter use your project folder:

C:\Users\YourUsername\YourProjectPath> MiletusPackager .

or

C:\Users\YourUsername\YourInstallationFolderPath\Win64> MiletusPackager "my_project_folder"

Linux

Unzip the contents into a folder of your choice. Keep in mind to maintain the original folder structure.

After unzipping, make sure to verify your download first by calling the packager with the -v parameter from the Linux folder. This will print the current MiletusPackager version.

username@machinename:~/InstallationFolder$ MiletusPackager -v

Note

On Linux it's possible the execute attribute will be lost. Use chmod to set the correct attributes first.

If this prints the help page as expected then you can start using the packager:

username@machinename:~/InstallationFolder$ MiletusPackager "my_project_folder"

Add the path to the packager to manually to the $PATH variable if you'd like to acces it from anywhere.

macOS

The .pkg installation file will install the packager and add the correct packager to the $PATH variable automatically. This way after installation the packager is ready to be used from the terminal.

Make sure to verify your installation first by calling the packager with the -v parameter. This will print the current MiletusPackager version.

user@device ~ % MiletusPackager -v

If this prints the help page as expected then you can start using the packager:

user@device ~ % MiletusPackager "my_project_folder"

Or in the project folder:

user@device MyProjectFolder % MiletusPackager .

VSCode Extension

The VSCode extension takes care of storing the packager and shell binaries while providing commands to make the bundling process as easy as possible.

Search for Miletus Packager on the VSCode extension marketplace and install. Alternatively you can download the latest VSIX file from here.

The following commands are available:

• Miletus: Package application

  Packages the application.

• Miletus: Initialize config

  Creates a minimal template configuration file in the root folder.

• Miletus: Package and run

  Packages the application. If the current platfom is in the target, it also will automatically launch the application.

• Miletus: Register license

  Registers a license.

License activation

License registration depends on which version of the packager was downloaded.

• Direct download: From your terminal/command line prompt:

  MiletusPackager -rl -email:your_email -code:your_reg_code
  

• VSCode Extension: Use the Miletus: Register license command from the command pallette.

Output

You can expect the following outputs after running the packager.

Platform	Output
Windows	A .exe single executable file
macOS	An .app application and the .entitlements entitlement.
Linux and Raspberry Pi	An executable file + a .desktop file that serves as a sample as well as a starting point. Feel free to modify this .desktop file to your needs or ignore it completely!