Package: tabcmd
TabcmdAn open source, cross platform command-line utility which you can use to automate site administration tasks on your Tableau Server site.Download exe (or rpm/deb)To download the latest release as an executable seehttps://github.com/tableau/tabcmd/releasesThere is no need to install: open a command line in the same folder as the exe and runtabcmd[command_name][--flags]e.gtabcmd login --username [username] --password [password] --server [server_name] --site [site_name]tabcmd createproject --name [project_name]tabcmd help###orInstall on the command line(Note: this requires Python 3.7+. Generally we will actively support versions of Python that are still in security support).pipinstalltabcmdOr install the current work-in-progress version from GitOnly do this if you know you want the development version, no guarantee that we won't break APIs during developmentpipinstallgit+https://github.com/tableau/tabcmd.git@developmentIf you go this route, but want to switch back to the non-development version, you need to run the following command before installing the stable version:pipuninstalltabcmdRun tabcmdTo run tabcmd from your local copy, from a console window in the same directory as the file tabcmd.py:Clone the repoRunpip install .buildpython setup.py buildrun testspytestrun tests against a live serverpython -m tabcmd login {your server info here}
pytest -q tests\e2e\online_tests.py -r pfEwith coverage calculation (https://coverage.readthedocs.io/en/6.3.2)coverage run -m pytest && coverage report -mautoformat your code with black (https://pypi.org/project/black/)black --line-length 120 tabcmd tests [--check]type check with mypymypy tabcmd testspackaging is done with pyinstaller. You can only build an executable for the platform you build on.To package a release, we first bump the version withdoit versionand build as 2.x.0 before packagingpyinstaller tabcmd\tabcmd.py --clean --noconfirmproduces dist/tabcmd.exe
To run tabcmd during development, from a console window in the same directory as the file tabcmd.py:dist/tabcmd/tabcmd.exe --helppython -m tabcmd.py [command_name] [--flags]Examples:tabcmd.py login --username [username] --password [password] --server [server_name] --site [site_name]tabcmd.py createproject --name [project_name]tabcmd.py helpFor more examples and information about the available commands and options,
see the user documentation athttps://tableau.github.io/tabcmd/Release NotesVersion 2 is the first version of tabcmd built in python.
It is specifically targeted to support users of Tableau Online, who are required to have MFA enabled.
(MFA support is not available in the tabcmd program that ships with Tableau Server).Version 2 does not yet fully replace the existing tabcmd client, in particular itdoes not support most server admin actions.
For known gaps in supported functionality, see the latestrelease notesAboutTabcmd has been shipped with Tableau Server, and for at least 2022 it will continue being shipped with new installs of Server.
This new version of tabcmd can be updated for users at any time, without waiting for a new release of Server.
Significant new features will only be added to this new version.Which one do I have?Copies of tabcmd that shipped with Tableau Server are referred to by the version number they shipped in: e.g. tabcmd 2020.4, tabcmd 2021.4, etc. The first version built in python is tabcmd 2.0. To see the version of your current tabcmd, runtabcmd -vWill one of them go away?At some point in the future, tabcmd will no longer be included with Tableau Server.We have no intention of breaking Server install flows.If you have specific suggestions or concerns on what that will look like, feel free to open an issue here or a thread on the Community Forums.