Skip to main content
Clicknium
☰

Clicknium Visual Studio Code Extension

Overview​

For Python developers using Visual Studio Code, Clicknium extension provides features to create Python automation project, capture/edit/validate and recapture UI element locators for browsers and various types of desktop applications, run/debug the automation project, package the project as standalone executable file, and central locator store management on the cloud.
Besides, Clicknium also improves writing code experience, such as Code IntelliSense, error hint, etc.

Installation​: Install Clicknium extension through Visual Studio Code marketplace or search clicknium in Visual Studio Code Extension marketplace.
Remarks: Clicknium extension has dependency on Python extension, and the extension will be installed automatically.

Connect to Cloud​

You are required to sign up to Clicknium after installation, or sign in with a Google or GitHub account. Please go to Connect to Cloud for more information.

Extension Installation​

Clicknium extension provides different extensions for automation. For example, Edge Extension helps you execute automation on Microsoft Edge browser. You can select and install extensions before writing automation code. For more information, please ref to Automation Extensions

Create Project​

Open the Command Palette: Ctrl+Shift+P

  • Input or select: Clicknium: Create Project
  • Select project path
    • You can create one empty folder and select it, and the new project will be created.
    • You can also select one existing folder which will be converted to Clicknium project, and there is no impact on existing source files. You can go to Project Management for more information.

Capture UI Locators​

In Visual Studio Code, press CTRL+F10 to invoke Clicknium recorder to capture UI element locators.
clicknium recorder
The Capture Technology indicates which automation technology is currently used to capture UI elements. Default is Auto Detect, which means Clicknium recorder will automatically detect the application type and choose the automation technology accordingly for locators capturing. You can go to Clicknium Recorder for more information.

Edit and Validate Locator​

After capturing the locators, you can open and edit the locator in the editor as below.
clicknium vscode

You can go to Locator Store for more information about locator management.
For more about the locator, please refer to Clicknium Locator.

After editing the locator, you can press the button Validate to minimize Visual Studio Code and verify if the target element can be located by the locator. The locator validation result is displayed at the head of each locator layer.
validate error

Writing code​

Clicknium provides plenty of features to help you write automation code more efficiently. For example:

  • Auto Code Complete
    For the locator parameter in cc.find_element(, you can press Ctrl+F10 to invoke Clicknium Recorder to capture a UI element. Once you complete the capturing, the captured element will be automatically filled to code like cc.find_element(locator.chrome.bing.search_sb_form_q) in Visual Studio Code.

  • IntelliSense
    If you want to choose one locator in the locator store, Clicknium code extension shows the locator store list and the locator list for you to choose.
    intellisense
    Please go to Code IntelliSense for more features.

Run/Debug Project​

There are two ways to debug Clicknium Automation Project:

  • Run/Debug using F5 or Ctrl+F5, which is the same way as you debug other Python scripts.
  • Open the Command Palette: Ctrl+Shift+P, input or select: Clicknium: Run to run project or Clicknium: Debug to debug project.
    It will configure the running/debugging environment. For example, check the Python version in clicknium.yaml, restore dependent package list, etc.

Package Project​

When a project is developed, you can distribute the package to the non-developer end users. Clicknium provides features to package the project as one executable file, so the end user can run automation tasks by double clicking it.
Open the Command Palette: Ctrl+Shift+P, Input or select: Clicknium: Package to package project.
For more details, please refer to Project Package.