This Visual Studio Code extension provides comprehensive support for the Tally Robot Script scripting language, specifically designed for automated testing of Tally software. The extension includes features such as autocomplete, hover information, error diagnostics, and custom commands to streamline script creation, formatting and ensure efficiency and accuracy.
Features
- TallyRobot Script AI command box with dual modes:
- Local Mode — Review, Search Maps, Open Map, Run Scripts
- TallyRobot AI Mode — AI-powered assistance with Cognito authentication
- Script review with inline fix suggestions
- Search in map files
- Open map file
- Context aware autocomplete
- Code Snippets and hover information
- Template scripts
- Syntax highlighting for Tally Robot scripts
- Formatting for Tally Robot scripts
- Syntax highlighting for map files
- Error detection
- Run scripts directly via Visual Studio Code (powered by Tally Robo 2.0)
- Mock API Log Extraction Tool
TallyRobot Script AI Command Box
The extension includes a dedicated TallyRobot Script AI sidebar panel accessible from the activity bar. The command box lets you interact with the extension using natural language commands from a single place — no need to hunt through menus or the command palette.
You can type commands such as:
| Command |
What it does |
review |
Reviews the active script and shows issues with fix suggestions |
search maps <query> |
Opens the map search panel pre-filled with your query |
open map <name> |
Opens the specified map file from the current maps library |
run base |
Executes the script in base generation mode |
run gui |
Executes the script with custom config (Tally Robo 2.0 GUI) |
settings |
Opens the extension settings |
maps path |
Updates the maps library directory path |
repo path |
Updates the code.robotscript repository path |
tally robo path |
Updates the Tally Robo 2.0 executable path |
The command box also maintains a chat history across sessions. Each session stores your commands and bot responses, and you can switch between sessions or start a new one using the session header controls.
Tips:
- Type
help or what can you do to see a quick summary of available commands.
- Review artifacts (completed reviews) are saved in the session history as clickable cards — click any card to re-open that review.
- Use the ⊕ button in the session header to start a fresh session, or the ☰ button to browse and switch between past sessions.
TallyRobot AI Mode
The extension now supports TallyRobot AI Mode with AWS Cognito authentication and Bedrock integration. This mode enables AI-powered assistance for script development while maintaining all Local mode functionality.
Features:
Getting Started:
Switch to TallyRobot AI Mode:
- Click the provider dropdown in the command box
- Select "TallyRobot AI"
- Click "Generate OTP" button
- Enter the OTP sent to your email
- Start using AI-powered features!
Configuration (Optional):
- The extension comes with pre-configured AWS settings
- For custom deployments, see
SETTINGS_SETUP.md for advanced configuration
- See
tallyrobot-ai.settings.json for reference configuration
Security:
- All credentials are stored securely in VS Code settings
- Bearer tokens are automatically managed and refreshed
- OTP sessions expire after 30 minutes
- Email domain restriction available for enterprise deployments
- Cognito tokens encrypted at rest using VS Code SecretStorage
Troubleshooting:
If you encounter issues with TallyRobot AI Mode:
- Check
CONNECTIVITY_PLATFORM.md for technical details
- Verify AWS endpoints are accessible
- Check AWS Lambda logs in CloudWatch for authorization errors
- For custom configuration issues, see
SETTINGS_SETUP.md
Script Review
The Review feature analyses your active Tally Robot Script and surfaces errors, warnings, and informational hints — all within the sidebar panel. Each issue is shown with a description and, where applicable, a one-click Accept Fix button to apply the suggested correction directly in the editor.
To trigger a review:
- Type
review in the command box, or
- Click the Review Script button (checklist icon) in the editor title bar, or
- Right-click in the editor and choose Review Script from the context menu.
Tips:
- Use Accept All Fixes to apply every auto-fixable suggestion in one go.
- Use Undo Fix to revert the last applied fix.
- Click Go to Line on any issue to jump directly to the relevant line in the editor.
- After a review is complete, a summary card (showing error / warning / info counts) is saved in the session history. Click it at any time to re-open that review result.
Search In Map Files
You can conveniently search for key sequences, report names, or keywords within the map files of the active maps library by selecting the "Search In Map Files" option from the context menu (right-click in the editor). Additionally, the "Search In Map Files" command is accessible through the command palette (Ctrl+Shift+P), or by typing search maps <query> in the command box.
The map search panel opens inside the sidebar and provides:
- Release selector — switch between available releases or browse a custom maps folder without leaving the panel.
- Search scope — narrow results to All Fields, Map Names only, or Loop Parms only.
- Mapfiles filter — expand the Mapfiles panel to select or deselect individual
.map files to search within.
Tips:
To search for a keyword within the editor, highlight it with the cursor, right-click to access the context menu, and choose the "Search In Map Files" option to locate that keyword in the map files.
You can press Enter (or click a result card) to insert the selected map entry into your script in the correct MapFile | <file> | <mapname> | format.
The file selection is remembered across sessions — the same set of map files will be pre-selected the next time you open the search panel.
Use the Show Selected button in the Mapfiles panel to quickly review which files are currently included in the search.
Open Map File
Access any map file from the current maps library swiftly by selecting the "Open Map File" option in the context menu (right-click within the editor). You can also utilize the "Open Map File" command from the command palette (Ctrl+Shift+P).
Tips:
- To open a map file name that is currently displayed in the editor, you can easily highlight it with your cursor, right-click to access the context menu, and choose the "Open Map File" option for a quick access to that map file.
Context Aware Autocomplete
Receive smart autocomplete recommendations while you type, tailored to the context of various parameters such as the active map file library, the map file in use, and the current map name.
Template Scripts
If your team often utilizes a specific script pattern or style, you can now designate that script as a template by commiting it in the code.robotscript/templates/ directory. After this is completed, team members will be able to use the "Insert Template Script" autocomplete feature in the editor, allowing for quick insertion of the template script and enhancing efficiency.
This extension includes a custom formatter specifically designed for Tally Robot Scripts, allowing you to enhance and beautify your scripts with a single click. To format your script, right-click within the script area to access the context menu and choose the format document option. Upon your initial formatting attempt, you may encounter a popup indicating that no default formatter has been established for Tally Robot Scripts. If this occurs, just click on the "Configure" or "Select Formatter" option in the popup and choose the tallyrobotscript formatter from the dropdown menu.
Compilation and Error Detection
Compile your scripts to detect all errors at once, thus avoiding the tedious process of running the script, facing errors, correcting them, and re-executing it to pinpoint individual issues. Furthermore, obtain valuable suggestions for possible solutions to tackle each identified problem. To compile your script, right-click within the script and choose the "Compile Robot Script" option from the context menu. You can also utilize the "Compile Robot Script" button located on the top bar or editor title bar.
Script Execution
Run your scripts effortlessly with a single click in one of the two available modes, powered by Tally Robo 2.0. The base generation mode allows for the rapid creation of a local base complete with test case screenshots, while the custom config mode launches the Tally Robo 2.0 GUI, enabling you to tailor all execution parameters to meet your specific needs prior to script execution.
You can initiate your script using either the buttons on the top bar/editor title bar or by selecting the execute commands from the context menu (right-click) within the active editor.
FAQ (Frequently Asked Questions)
1. How to know/check which maps library is currently in use for providing the autocomplete suggestions?
The most straightforward method to identify the active map file library is to check the maps library indicator located on the right side of the status bar (the bottom bar in Visual Studio Code). For instance, if the indicator displays Release_6.0, it indicates that the map files from code.robotscript/Release_6.0/lib.maps (on your local machine) are currently utilized for autocomplete functionality.
When dealing with a script file from the code.robotscript repository, the extension automatically adjusts the maps library based on the context. For instance, if you access the script located at code.robotscript/Release_6.0/User_Sagar/testscript.txt, the extension recognizes it as a script within Release_6.0 and subsequently changes the maps library to code.robotscript/Release_6.0/lib.maps.
If a script is located outside the code.robotscript repository, the extension will continue to utilize the currently employed maps library unless the user explicitly modifies this setting.
In cases where the automatic switching of maps libraries does not function correctly, defaults to an incorrect library, or if the user prefers to manually select a maps library, the user has the option to utilize the "Change Maps Library Directory Path" feature found in the context menu (right-click) of the editor. Additionally, the user can simply click on the maps library status bar indicator and choose the preferred maps library from the dropdown menu.
2. Automatic maps library switching is not working properly for me. What to do?
This issue may arise from the local code.robotscript repository path not being configured correctly in the extension settings. Initially, when you run the extension for the first time, you will receive a prompt to specify the code.robotscript path on your system. However, if you inadvertently closed that prompt or if the path has changed since then, you can manually update it by selecting the "Change code.robotscript Path" option in the editor's context menu (right-click). Alternatively, you can also access this option through the Visual Studio Code command palette (Ctrl+Shift+P).
3. I have opened a Tally Robot Script(.txt) file but I am not at all getting any syntax highlighting or autocomplete features. What could be the issue?
Visual Studio Code may be identifying the file with a .txt extension as a standard text file rather than a Tally Robot Script file. To resolve this issue, you can manually adjust the file's language setting from the status bar at the bottom of Visual Studio Code to Tally Robot Script. Another option is to utilize the "Change Language Mode" command available in the command palette (Ctrl+Shift+P) to modify the file's language.
4. I get errors when trying to execute my script via Visual Studio Code. What should I do?
Ensure that the Tally Robo 2.0 path is correctly configured in the extension settings. Initially, when you attempt to run a script for the first time, a prompt will appear asking you to specify the Tally Robo 2.0 executable path on your system. If you inadvertently closed that prompt or if the executable path has changed, you can manually update the path by selecting the "Change Tally Robo 2.0 Executable Path" option from the editor's context menu (right-click). Alternatively, this can also be accomplished through the Visual Studio Code command palette (Ctrl+Shift+P).
5. I find myself using certain commands often and want to add keyboard shortcuts for them. Is it possible?
Visual Studio Code provides users with the ability to create custom keybindings for nearly any command or action within the editor. To access the keyboard shortcuts interface, you can open the command palette by pressing Ctrl+Shift+P and selecting "Preferences: Open Keyboard Shortcuts." In this section, you can search for the desired command and customize its shortcut according to your preferences.
6. The command box says "Command not recognized." What commands can I use?
The command box understands natural language variations of the following actions: review, search maps <query>, open map <name>, run base, run gui, settings, maps path, repo path, and tally robo path. You can also type help to get a quick reminder of available commands directly in the chat.
7. Can I search map files for a specific release without changing the global maps library?
Yes. The map search panel has its own release selector in the header. You can switch to any available release (or browse a custom folder) directly within the search panel — this only affects the search scope and does not change the global maps library used for autocomplete.
2.0.1 release changes
A new Mock API Log Extraction Tool has been added to the extension to simplify the process of generating mock data from API logs.
Key Highlights
- Extracts relevant API endpoints directly from log files
- Reduces manual effort in identifying and structuring API data
- Helps accelerate mock data creation for testing and development
- Seamlessly integrated into the extension workflow
This feature streamlines the end-to-end process of working with API logs, making script creation faster and more efficient.
