Initialising nusex

This section will run through initialising nusex to make it ready to use.

In order to initialise nusex, run the following command:

nsx init

You will be asked to provide some information to help nusex dynamically fill in information when deploying templates. You will need to provide:

• Your name, or the name you want to use for your projects

• Your email, or the email of your company/organisation

• Your GitHub/Gitlab/BitBucket (or other sevice) user profile link (for example: https://github.com/nusex)

nusex does store more configuration information, but you change that later using the config command. You can find the created configuration file in /home/[username]/.config/nusex/user.nsc (Linux & macOS) or C:/Users/[username]/.nusex/user.nsc (Windows). It is safe to edit the file manually, so long as you don’t change any of the keys.

After you’ve provided this information, nusex proceeds to download the latest premade templates from the assets repository. These templates are:

• simple_app, for general applications

• simple_pkg, for PyPI packages

You can deploy these templates by using the deploy command. They are stored as .nsx files in the same directory as the user configuration file.

Warning

The directory from where templates are downloaded from changed in v0.4.2. Once v1.0 releases, all versions prior to v0.4.2 won’t be able to download premade templates.