Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
albertospelta committed Jun 20, 2024
1 parent f4e7dc5 commit 3c59e0f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release-vpax-cli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY2 }}
34 changes: 31 additions & 3 deletions src/Dax.Vpax.CLI/README.md
Original file line number Diff line number Diff line change
@@ -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=<SERVER>;Initial Catalog=<DATABASE>"
````

Use `vpax -?` or `vpax export -?` to learn more.

```
Description:
Export a VPAX file from a tabular model
Usage:
vpax export <path> <connection-string> [options]
After installing you can invoke the tool using the `vpax` command. Use `vpax -?` to learn more.
Arguments:
<path> Path to write the VPAX file
<connection-string> 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
```

0 comments on commit 3c59e0f

Please sign in to comment.