From 3c59e0f3c38ba0e428df1ee834491c13120e8f0f Mon Sep 17 00:00:00 2001 From: Alberto Spelta Date: Thu, 20 Jun 2024 18:11:05 +0200 Subject: [PATCH] Update README.md --- .github/workflows/release-vpax-cli.yml | 4 +-- src/Dax.Vpax.CLI/README.md | 34 +++++++++++++++++++++++--- 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release-vpax-cli.yml b/.github/workflows/release-vpax-cli.yml index d8b2438..7ce2360 100644 --- a/.github/workflows/release-vpax-cli.yml +++ b/.github/workflows/release-vpax-cli.yml @@ -20,6 +20,6 @@ jobs: run: dotnet pack 'src/${{ env.PROJECT }}/${{ env.PROJECT }}.csproj' -c Release -o . - shell: bash name: nuget push - run: dotnet nuget push './${{ env.PROJECT }}.${{ steps.nbgv.outputs.NuGetPackageVersion }}.nupkg' -k "$NUGET_API_KEY" -s https://api.nuget.org/v3/index.json + run: dotnet nuget push './${{ env.PROJECT }}.${{ steps.nbgv.outputs.NuGetPackageVersion }}.nupkg' -k "$NUGET_API_KEY2" -s https://api.nuget.org/v3/index.json env: - NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} \ No newline at end of file + NUGET_API_KEY: ${{ secrets.NUGET_API_KEY2 }} \ No newline at end of file diff --git a/src/Dax.Vpax.CLI/README.md b/src/Dax.Vpax.CLI/README.md index 1c93db2..d785e5c 100644 --- a/src/Dax.Vpax.CLI/README.md +++ b/src/Dax.Vpax.CLI/README.md @@ -1,13 +1,41 @@ +# Dax.Vpax.CLI + This is a .NET tool that provides CLI access to [VertiPaq-Analyzer](https://github.com/sql-bi/VertiPaq-Analyzer) functions. Operations supported by this tool are: - Export a VPAX file from a tabular model. +## How to install the tool + The tool can be installed using the following command: -```shell -dotnet tool install -g Dax.Vpax.CLI +````bash +dotnet tool install Dax.Vpax.CLI --global +```` + +## How to run the tool + +````bash +vpax export "C:\output\file.vpax" "Provider=MSOLAP;Data Source=;Initial Catalog=" +```` + +Use `vpax -?` or `vpax export -?` to learn more. + ``` +Description: + Export a VPAX file from a tabular model + +Usage: + vpax export [options] -After installing you can invoke the tool using the `vpax` command. Use `vpax -?` to learn more. +Arguments: + Path to write the VPAX file + Connection string to the tabular model + +Options: + --overwrite Overwrite the VPAX file if it already exists [default: False] + --exclude-bim Exclude the BIM model (Model.bim) from the export [default: False] + --exclude-vpa Exclude the VPA model (DaxVpaView.json) from the export [default: False] + -?, -h, --help Show help and usage information +```