Telosys doc
WebsiteTwitterLinkedInNews
  • Telosys documentation
  • Telosys CLI
    • Installation on Linux
    • Installation on Windows
    • CLI configuration
    • CLI commands
    • Getting started
  • Telosys with VSCode
    • Extension installation
    • VSCode settings
    • Telosys terminal in VSCode
    • Telosys editor configuration
  • Telosys with JetBrains IDE
  • Project configuration
  • Project variables
  • Project databases
  • Models and entities
    • Model structure
    • Entity
    • Attribute / Link
    • Annotations
    • Tags
    • Examples
    • Model creation
    • Model installation
    • Models management
  • Bundles of templates
    • Bundle structure
    • Bundle creation
    • Bundles installation
    • Bundles management
    • Velocity language
    • Velocity directives
    • Velocity object types
    • Telosys directives
    • Telosys variables
    • Telosys objects
    • Code snippets
  • Code generation
    • "gen" command
    • "genb" command
  • Target languages
    • C++
    • C#
    • Golang
    • Java
    • JavaScript
    • Kotlin
    • PHP
    • Python
    • Scala
    • TypeScript
  • Target databases (SQL)
    • Predefined rules
    • Specific rules
    • Type size and precision
  • Telosys with Git
    • GitHub usage
    • Install with Git
    • Publish with Git
  • Support the project
  • How to contribute
  • Sponsors
  • IDE and editors
  • Telosys 3 Eclipse plugin
    • Eclipse plugin installation
    • Eclipse customization
    • Telosys 3 database model
Powered by GitBook
On this page
  • Standard terminal usage
  • Specific terminal profile
  • Open the "settings.json" file
  • Edit the "settings.json" file
  1. Telosys with VSCode

Telosys terminal in VSCode

PreviousVSCode settingsNextTelosys editor configuration

Last updated 1 year ago

Visual Studio Code includes a full featured integrated terminal that starts at the root of your workspace ( see ).

This terminal is the ideal place to launch and use Telosys-CLI. So you can run all Telosys-CLI commands while staying in VSCode.

Standard terminal usage

The most basic way to use Telosys in VSCode is to launch a standard terminal (predefined in VSCode) to get a shell and to launch Telosys from the command line.

But you will have to launch Telosys manually and to set the home directory each time you want to use it.

What's more, the terminal's name is "java", which is not self-explanatory.

To benefit from a dedicated Telosys terminal, simply create a "terminal profile", as described below...

Specific terminal profile

Here's how to define a terminal profile for Telosys by editing the "settings.json" file.

Open the "settings.json" file

Launch the "command palette" with [ Ctrl ] + [ Shift ] + [ P ]

Search "open settings json"

Choose the JSON file to edit: "User Settings" JSON file (recommanded to be able to use the terminal in any workspace) or "Workspace Settings" JSON file (to store the file in the current workspace)

Edit the "settings.json" file

In section "terminal.integrated.profiles.windows" add an entry for "Telosys" with

  • "path" -> the command to launch = Java executable file

  • "args" -> the command arguments:

    • "-jar" + "full path to telosys-cli-X.X.X-nnn.jar" this is the ".jar" file to be executed by Java = telosys jar file do not forget to change it when you upgrade Telosys to a new version

    • "-h" + "." to define the current directory as the Telosys "home" ( for a VSCode terminal the current directory is the root of your workspace )

  • "overrideName" = "true" -> to replace the dynamic terminal title

  • "icon" -> optional (just to set a specific terminal icon )

  • "color" -> optional ( just to set the icon color )

Example:


    "terminal.integrated.profiles.windows": {

        "PowerShell": {
            "source": "PowerShell",
            "icon": "terminal-powershell"
        },
        "Command Prompt": {
            "path": [
                "${env:windir}\\Sysnative\\cmd.exe",
                "${env:windir}\\System32\\cmd.exe"
            ],
            "args": [],
            "icon": "terminal-cmd"
        },
        "Git Bash": {
            "source": "Git Bash"
        },

        "Telosys": {
            "overrideName": true,
            "path": [
                "C:\\PATH\\TO\\JAVA\\bin\\java.exe"
            ],
            "args": ["-jar", "C:\\PATH\\TO\\TELOSYS\\telosys-cli-4.0.0-001.jar", "-h", "."],
            "icon": "terminal",
            "color": "terminal.ansiGreen"
        }
   },

After this configuration "Telosys" appears as a new kind of terminal in VSCode

so you just have to launch it and it is ready to use in the current workspace

Telosys terminal with "rocket" icon :

VSCode allows to define specific terminal profiles ( see )

https://code.visualstudio.com/docs/terminal/profiles
https://code.visualstudio.com/docs/terminal/basics