Git Console

Applies to ReadyAPI 3.57, last modified on December 20, 2024

The Git console provides a way to run Git commands from the command line. You can launch the console directly from ReadyAPI.

About

The ReadyAPI UI provides access to some of the most widely used Git commands, as described in the previous topics of the section. However, there are commands that cannot be performed via the UI. This is where the console proves to be useful: it allows you to run all Git commands.

ReadyAPI uses the Git Bash console. It is a Linux-based command line that has implementations for Windows and macOS. All the commands in Git Bash are identical on all the platforms.

Tip: For a reference on Git Bash commands, visit the https://git-scm.com/docs page, or run the git help command in the console.

Set up console

To set up the Git console:

  1. Click Git on the main toolbar.

  2. Click and select Setup Git Console:

    Setup Git console

    Click the image to enlarge it.

  3. On the Git tab that opens, enter the path to the installed Git Bash console in the Path to Git console field. You can click the Browse button and browse for the file.

    Git integration: Path to Git console

    Click the image to enlarge it.

  4. Click OK.

  1. Make sure your project is a composite project.

  2. Right-click a project node in the Navigator and select Git > Setup Git Console from the context menu:

    Show image

    — or —

    Select Project > Git > Setup Git Console from the main menu:

    Show image

  3. On the Git tab that opens, enter the path to the installed Git Bash console in the Path to Git console field. You can click the Browse button and browse for the file.

    Git integration: Path to Git console

    Click the image to enlarge it.

  4. Click OK.

Launch console

To launch the Git console after setting it up:

  1. Click Git on the main toolbar.

  2. Click and select Open Git Console:

    Git integration: Launch Git console

    Click the image to enlarge it.

The console will launch:

Git integration: Git console
Note: When you launch the Git console, the current working directory is set to the folder of the project from which you launched the console.
  • Right-click a project node in the Navigator and select Git > Launch Git Console from the context menu:

    Show image

    — or —

  • Select Project > Git > Launch Git Console from the main menu:

    Show image

Working with console

Below, you will find some examples of typical tasks that you can perform with the Git console.

Do the initial push to an empty repository

Commit and push to the remote repository

Update from the remote repository

Branch from main branch

Merge into main branch

Change the URL of a remote repository

See Also

Git Integration
Teamwork
Git Bash command reference

Highlight search results