Skip to content

Vendor Functions

Vendor is related to specific software vendors and integration with the shell.

🛠️ Tools · ⬅ Top

contextOpen

Open a file in a shell using the program we

Usage

contextOpen [ --help ]

Open a file in a shell using the program we are using. Supports VSCode and PHPStorm.

Arguments

  • --help - Optional. Flag. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Environment

  • EDITOR - Callable. Binary for editing files
  • Used as a default editor (first)
  • VISUAL - Executable. Binary for viewing files
  • Used as another default editor (last)

contextShow

Show the current editor being used as a text string

Usage

contextShow

Show the current editor being used as a text string Return Code: 1 - If no editor or running program can be determined

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Environment

  • EDITOR - Callable. Binary for editing files
  • Used as a default editor (first)
  • VISUAL - Executable. Binary for viewing files
  • Used as another default editor (last)

isPHPStorm

Are we within the JetBrains PHPStorm terminal?

Usage

isPHPStorm [ --help ]

Are we within the JetBrains PHPStorm terminal?

Return Code: 0 - within the PhpStorm terminal Return Code: 1 - not within the PhpStorm terminal AFAIK

Arguments

  • --help - Optional. Flag. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

isPyCharm

Are we within the JetBrains PyCharm terminal?

Usage

isPyCharm [ --help ]

Are we within the JetBrains PyCharm terminal?

Return Code: 0 - within the PyCharm terminal Return Code: 1 - not within the PyCharm terminal AFAIK

Arguments

  • --help - Optional. Flag. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

isVisualStudioCode

Are we within the Microsoft Visual Studio Code terminal?

Usage

isVisualStudioCode [ --help ]

Are we within the Microsoft Visual Studio Code terminal?

Return Code: 0 - within the Visual Studio Code terminal Return Code: 1 - not within the Visual Studio Code terminal AFAIK

Arguments

  • --help - Optional. Flag. Display this help.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error