Installation and Setup

Once you have created an account with TestProject you just need to follow a few simple steps to get setup and ready for testing. TestProject works on almost any platform, with the install of a single agent.

The first thing you will need to do is login to the TestProject app. Once you have done that you can go to the agents tab at the top of the page and click on the link for the platform you are on to download the agent executable or go to Agent Download. Once that download has finished you can use it to install the TestProject agent on your machine.

After that there is only one step left. You need to register you agent with the TestProject app so that you can use it to create and run tests. In order to do that, the agent needs to be running on your local machine. You can start it up by finding the installed TestProjectAgent executable on your machine and running that.

Starting the TestProject Agent

Starting the agent on Windows

On Windows the easiest way to run the agent is just to search for TestProject in the Windows search bar and clicking on the Agent to start it.

TestProject Agent on Windows

The agent will then start up on your computer and you will be able to see the status of it by right clicking on the icon in the system tray.

TestProject Status in System Tray

Starting the agent on Mac

On Mac, after you have installed the agent, you can run it by finding it in the application folder and double clicking. This will open it in the dock and you can see the options on it by right clicking

TestProject Agent on Mac

Starting the agent on Linux

First navigate to TestProject app:

cd /home/UserName/testproject/agent/bin

Don't forget to replace UserName with the actuall user

Than start the agent in fork mode so you can use the current terminal:

./testproject-agent start -f

It should look like this:

Starting the agent on Linux terminal

Register the Agent

Register the agent via UI

Once you have verified that the agent is running, you can go into the TestProject app and choose the Register an Agent option from the Agents menu.

Registering the agent from TestProject app

You will be prompted to give your agent an alias. Put something meaningful in here like "Joe Smith's Windows laptop" as it is possible to share agents with other team members. Once you have done that you just need to click on the register button to automatically register your agent with the TestProject application, and you are ready to start using TestProject!

Register the agent via CLI

This method can be used for remote agent registration.

To register your agent to an account using a CLI on any machine you will need to generate an API key or a Development Token.

Note: the API key and or Development token will determine to which account this agent will register to.

For Linux

Once you have your API key head over to the terminal and make sure your agent is running.

You can verify it here.

Now to register your agent use this command:

./testproject-agent register -a agantName -t Your_API_Key _or_DevelopmentToken

It should look like this:

Registering the agent on Linux terminal

For Windows

First make sure your agent is running you can check here.

Simply execute this command on your shell or CMD:

testproject-agent register -a agentName -t Your_API_Key _or_DevelopmentToken

It should look like this:

Registering the agent on Windows CMD

If your windows does not recognize testproject-agent commands:

Add TestProject agent to your environment variables

Head to Control Panel -> All Control Panel Items -> System -> Advanced system settings -> Advanced -> Environment Variables -> Path -> New

Variable value: C:\Program Files\TestProject Agent

You can use the image below:

Adding test project agent to Environment Variables