Skip to content

Installation Manual

Jump to bottom
Benoît Garçon edited this page Jan 26, 2020 · 2 revisions

Table of contents

1. Introduction

This document explains how to install i-Code CNES. Documentation on how to use i-Code is in the user manual [ R1 ].

This tool provides four products:

  • A standalone version with GUI named i-Code CNES IDE
  • A command line version named i-Code CLI or i-Code App
  • An Eclipse plugin
  • A SonarQube plugin [ R3 ]

Other products are available for developers:

  • i-Code Core: a library containing core features for developing new i-Code plugins, see [ R4 ] for more information
  • i-Code Library: a library allowing to analyze code in your own application

2. Installation guidelines

2.1. Download i-Code

i-Code CNES products are available on the GitHub Release page of i-CodeCNES repository: https://github.com/lequal/i-CodeCNES/releases.

For each release, the following products are available:

  • i-Code plugin for Eclipse
    • fr.cnes.icode.repository-X.Y.Z-SNAPSHOT.zip
  • i-Code CLI
    • icode-X.Y.Z.zip
  • i-Code IDE
    • icode-ide.product-linux.gtk.x86.zip
    • icode-ide.product-linux.gtk.x86_64.zip
    • icode-ide.product-macosx.cocoa.x86_64.zip
    • icode-ide.product-win32.win32.x86.zip
    • icode-ide.product-win32.win32.x86_64.zip

2.2. Install i-Code CLI

Download the latest i-Code CNES CLI version on GitHub Releases page. Then put the archive in your chosen location.

On linux

unzip icode-X.Y.Z.zip
alias icode=$(pwd)/icode/icode

On Windows (PowerShell)

Extract the archive, then:

Set-Alias icode c:\path\to\icode\icode.bat

2.3. Install i-Code IDE

2.4. Install i-Code plugin for Eclipse

  1. Download the eclipse plugin archive of the last release.

  2. Then, launch Eclipse and select the Help > Install new Software.

  3. On the wizard, select Add and Archive... and select i-Code CNES archive.

  4. Restart Eclipse.

2.5. Install i-Code plugin for SonarQube

All information about i-Code plugin for SonarQube is available on the official project's repository.

There are two ways for installing the i-Code plugin:

  • Through the official SonarQube Marketplace
  • Manually by downloading the plugin on its GitHub Release page and then following the installation guide in [ R5 ]

In any case, follow instructions of official SonarQube documentation for properly install this plugin [ R5 ].

3. References

i-Code CNES is an open source project under license EPL-1.0

Clone this wiki locally