XIP installer

XIP is XploR pip

xip (i.e. XploR pip) is a standalone application used for downloading, installing and managing the IDE and blueprints. xip can be downloaded from this link.

Tip: To install the XploR IDE with xip, use:

% xip install xplor-studio-ide

Introduction

Developers can use xip to:

  • signup: sign up for a free account from the command line. Alternatively, you can also used this link to sign up for a free account.
  • install: download and install XploR Studio IDE, or blueprints from XploR Design
  • uninstall: uninstall installed blueprints on the host machine.
  • show: show information about installed blueprints.
  • list: list all installed and available blueprints.

To get more information:

$ xip --help
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!			  

usage: xip [-h] [--version] [--xplor-home <path>] [--init]  ...

A Blueprint manager CLI

optional arguments:
  -h, --help           show this help message and exit

Commands:
  
    signup             Sign up for a free account.
    install            Install a blueprint.
    uninstall          Uninstall a blueprint.
    show               Show the information of a blueprint.
    list               List installed blueprints.

General options:
  --version            Show version and exit.
  --xplor-home <path>  Set the XploR workspace and set $XPLOR_HOME=<path> if
                       it not exists (Default: /home/ubuntu/.xplor).
  --init               Initialize the credentials file in the Xplor workspace
                       and exit

To get more info about subcommands (signup, install, uninstall, show, list):

$ xip install --help
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

usage: xip install [-h] [--no-deps] [--upgrade] blueprint

positional arguments:
  blueprint   The name of the blueprint to install.

optional arguments:
  -h, --help  show this help message and exit.
  --no-deps   Install a blueprint without dependencies.
  --upgrade   Upgrade a blueprint to the newest available version.

Sign up

To access blueprints and blueprint registry, users must sign up for an account here or using the xip signup command:

$ xip signup
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.060] Setup the workspace
[   0.060] The XploR's workspace folder already exists!
/home/dongnh/.xplor/blueprints
[   0.061] Getting the Registration Flow.
https://auth.soc.one/self-service/registration?flow=6aa1bf27-2985-483e-b780-de06742a9f1a
[   1.142] Getting email and password.
Enter your email: [email protected]
Enter your password: 
Re-enter your password: 
[  17.868] Signing up.
[  19.770] Sign up successfully.
[Notice] Please activate your account now by clicking the link in the activation email to access all our features and services.

Note: Please activate your account by clicking the link in the activation email.

Sign in

After signing up, users can authenticate with the registry with the following command: xip --init.

$ xip --init
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!			  

[   0.105] Setup the workspace.
[   0.105] The XploR's workspace folder already exists.
[   0.107] Credentials Verification.
Get a new token from the server.

Note: xip will open a browser for users to sign in. If login is successful, users will be requested access to some permissions.

Install

Use xip install to install blueprints with or without dependencies.

To install the GNU elf toolchain and related dependencies, use:

% xip install riscv-xplor-elf

To install without dependencies, use:

% xip install riscv-xplor-elf --no-deps

To upgrade blueprints to latest version:

% xip install --upgrade riscv-xplor-elf

Note: [Windows] There are some blueprints that need enabling Windows Long Path to be installed. Please refer to the article: Enable Long Paths in Windows 10.

Show

To show information about an installed blueprint:

$ xip show riscv64-xplor-linux
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.003] Setup the workspace
[   0.004] The XploR's workspace folder already exists!
/home/dongnh/.xplor/blueprints
Name: riscv64-xplor-linux
Version: 1.0
Summary: RISC-V Embedded Linux 64-bit Toolchain
Home-page: https://xplor.design
Author: SoC.One Inc.
Author-email: [email protected]
License: Free
Location: /home/dongnh/.xplor/blueprints
Requires: rootfs
Required-by: 

Uninstall

To uninstall the installed blueprint:

$ xip uninstall qemu
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.104] Setup the workspace.
[   0.104] The XploR's workspace folder already exists.
[   0.203] Uninstall qemu.
Found existing installation: qemu 1.0
Uninstalling qemu-1.0:
  Successfully uninstalled qemu-1.0
[   0.281] Uninstallation done!

List

To show all installed blueprints on the local machine:

$ xip list
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.004] Setup the workspace
[   0.004] The XploR's workspace folder already exists!
Package             Version
------------------- -------
qemu                1.0    
riscv64-xplor-linux 1.0    
rootfs              1.0    

To show all available blueprints for your account:

$ xip list --on-registry
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.103] Setup the workspace.
[   0.103] The XploR's workspace folder already exists.
[   0.203] Credentials Verification.
Get credentials from the file.
[   0.205] Getting data from registry.
[   4.750] Information of all blueprints on Registry:
+------+------------------------------+---------------+---------------+-----------+------------------+----------------------------+
|   No | Name                         | Version       | Versions      | License   | Classifier       | Requires                   |
+======+==============================+===============+===============+===========+==================+============================+
|    1 | openocd                      | 1.0.0         | 1.0.0         | Free      | Software         |                            |
+------+------------------------------+---------------+---------------+-----------+------------------+----------------------------+
|    2 | qemu                         | 1.0.0         | 1.0.0         | Free      | Software,        |                            |
|      |                              |               |               |           | Platform         |                            |
+------+------------------------------+---------------+---------------+-----------+------------------+----------------------------+
|    3 | riscv-xplor-elf              | 1.0.0         | 1.0.0         | Free      | Software         |                            |
+------+------------------------------+---------------+---------------+-----------+------------------+----------------------------+
|    4 | riscv32-xplor-linux          | 1.0.0         | 1.0.0         | Free      | Software         | rootfs                     |
+------+------------------------------+---------------+---------------+-----------+------------------+----------------------------+
|    5 | riscv32-xplord-linux         | 1.0.0         | 1.0.0         | Free      | Software         | rootfs                     |
+------+------------------------------+---------------+---------------+-----------+------------------+----------------------------+
|...

By default, the data is displayed in table format. Users can customize their views by adding the --format option. The available options are tabular and JSON.

$ xip list --on-registry --format json
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.004] Setup the workspace
[   0.004] The XploR's workspace folder already exists!
[   0.103] Credentials Verification.
Get credentials from the file.
[   3.662] Getting data from registry.
[   4.618] Information of all blueprints on Registry:
{
    "openocd-1.0.0": {
        "Metadata-Version": "1.1",
        "Name": "openocd",
        "Version": "1.0.0",
        "Summary": "Open On-Chip Debugger",
        "Home-page": "https://xplor.design",
        "Author": "SoC.One Inc.",
        "Author-email": "[email protected]",
        "License": "Free",
        "Description": "OpenOCD aims to provide debugging, in-system programming and boundary-scan testing for embedded target devices",
        "Platform": [
            "Windows",
            "Linux"
        ],
        "Classifier": [
            "Software"
        ],
        "Requires": [],
        "Size": "7.68 MB"
    }
    "qemu-1.0.0": {
    ...

User can select specific type of blueprints to display with the --filter option.

Blueprint types for display using --filter include software, hardware, cores, platforms, examples or all (using the none option).

$ xip list --on-registry --filter examples
      _  __     __     ___             
     | |/_/__  / /__  / _ \            
    _>  </ _ \/ / _ \/ , _/            
   /_/|_/ .__/_/\___/_/|_|             
       /_/   Explore your SoC Design!  

[   0.004] Setup the workspace
[   0.004] The XploR's workspace folder already exists!
[   0.106] Credentials Verification.
Get credentials from the file.
[   3.649] Getting data from registry.
[   4.600] Information of examples blueprints on Registry:
+------+---------------------------+-----------+------------+-----------+--------------+----------------------------+
|   No | Name                      | Version   | Versions   | License   | Classifier   | Requires                   |
+======+===========================+===========+============+===========+==============+============================+
|    1 | baremetal-neorv32-de2115  | 1.0.0     | 1.0.0      | Free      | Example      | bitstream-de2115-neorv32,  |
|      |                           |           |            |           |              | riscv-xplor-elf            |
+------+---------------------------+-----------+------------+-----------+--------------+----------------------------+
|    2 | baremetal-vexriscv-agilex | 1.0.0     | 1.0.0      | Free      | Example      | bitstream-agilex-vexriscv, |
|      |                           |           |            |           |              | riscv-xplor-elf            |
+------+---------------------------+-----------+------------+-----------+--------------+----------------------------+
...