Provide details on how to install on Windows

[leggetter]

The CLI builds for Windows, but it's not clear if the binary is distributed in the same way as it is for Mac and Linux.

Suggestion:

1. Check/update the build to ensure a Windows binary is built and distributed
2. Update the installation docs (README and https://www.tigrisdata.com/docs/sdkstools/cli/installation/) to provide instructions for Windows

[ovaistariq]

@efirs if this is something quick, could you look into it.

[leggetter]

Happy to do the docs and help with some testing.

[efirs]

I've created #223 to simplify installation on Windows.

But we always were publishing a binary for Windows https://github.com/tigrisdata/tigris-cli/releases/tag/v1.0.0-beta.22
Not sure what would be Windows idiomatic installation instructions.

Also would npm -i -g @tigrisdata/tigris-cli
work on Windows?

[ovaistariq]

Yes the npm command should work on windows as well

[leggetter]

@efirs sorry for the delay in looking into this. I thought the npm approach would work. However, the install tries to download the CLI archive in .tar.gz format:

PS C:\Users\phil> npm i -g @tigrisdata/tigris-cli
npm ERR! code 1
npm ERR! path C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli
npm ERR! command failed
npm ERR! command C:\WINDOWS\system32\cmd.exe /d /s /c node install.js install
npm ERR! Downloading from URL: https://github.com/tigrisdata/tigris-cli/releases/download/v1.0.0-beta.28/tigris_1.0.0-beta.28_windows_amd64.tar.gz
npm ERR! node:events:489
npm ERR!       throw er; // Unhandled 'error' event
npm ERR!       ^
npm ERR!
npm ERR! Error: TAR_BAD_ARCHIVE: Unrecognized archive format
npm ERR!     at Unpack.warn (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\warn-mixin.js:21:40)
npm ERR!     at Unpack.warn (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\unpack.js:229:18)
npm ERR!     at Unpack.<anonymous> (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:83:14)
npm ERR!     at Unpack.emit (node:events:523:35)
npm ERR!     at [emit] (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:303:12)
npm ERR!     at [maybeEnd] (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:426:17)
npm ERR!     at [consumeChunk] (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:458:21)
npm ERR!     at Unpack.write (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:385:25)
npm ERR!     at Unpack.end (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:505:14)
npm ERR!     at Gunzip.onend (node:internal/streams/readable:713:10)
npm ERR! Emitted 'error' event on Unpack instance at:
npm ERR!     at Unpack.onerror (node:internal/streams/readable:793:14)
npm ERR!     at Unpack.emit (node:events:511:28)
npm ERR!     at Unpack.warn (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\warn-mixin.js:21:12)
npm ERR!     at Unpack.warn (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\unpack.js:229:18)
npm ERR!     [... lines matching original stack trace ...]
npm ERR!     at Unpack.write (C:\Users\phil\AppData\Roaming\npm\node_modules\@tigrisdata\tigris-cli\node_modules\tar\lib\parse.js:385:25) {
npm ERR!   recoverable: false,
npm ERR!   cwd: 'C:/tmp',
npm ERR!   code: 'TAR_BAD_ARCHIVE',
npm ERR!   tarCode: 'TAR_BAD_ARCHIVE'
npm ERR! }
npm ERR!
npm ERR! Node.js v20.1.0

npm ERR! A complete log of this run can be found in: C:\Users\phil\AppData\Local\npm-cache\_logs\2023-05-09T13_20_25_200Z-debug-0.log

This format isn't supported (by default) on Windows.

Downloading from URL: https://github.com/tigrisdata/tigris-cli/releases/download/v1.0.0-beta.28/tigris_1.0.0-beta.28_windows_amd64.tar.gz

It looks like the goreleaser should handle this:
https://github.com/tigrisdata/tigris-cli/blob/c3aa0f01c9fb7538077fda98f8f6ee4bc5d1f4d9/.goreleaser.yaml#L19

But, clearly, something isn't working as it should.

[leggetter]

https://github.com/tigrisdata/tigris-docs/pull/396 adds NPM install instructions. We can merge that anyway, but we know it won't currently work for Windows.

[leggetter]

The zip file is uploaded (e.g. https://github.com/tigrisdata/tigris-cli/releases/download/v1.0.0-beta.28/tigris_1.0.0-beta.28_windows_amd64.zip) so the problem seems to be with the installation process

[tigrisdata-argocd-bot]

🎉 This issue has been resolved in version 1.0.0-beta.29 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[tigrisdata-argocd-bot]

🎉 This issue has been resolved in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀