Skip to content

Commit 3c59e0f

Browse files
committed
Update README.md
1 parent f4e7dc5 commit 3c59e0f

File tree

2 files changed

+33
-5
lines changed

2 files changed

+33
-5
lines changed

.github/workflows/release-vpax-cli.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ jobs:
2020
run: dotnet pack 'src/${{ env.PROJECT }}/${{ env.PROJECT }}.csproj' -c Release -o .
2121
- shell: bash
2222
name: nuget push
23-
run: dotnet nuget push './${{ env.PROJECT }}.${{ steps.nbgv.outputs.NuGetPackageVersion }}.nupkg' -k "$NUGET_API_KEY" -s https://api.nuget.org/v3/index.json
23+
run: dotnet nuget push './${{ env.PROJECT }}.${{ steps.nbgv.outputs.NuGetPackageVersion }}.nupkg' -k "$NUGET_API_KEY2" -s https://api.nuget.org/v3/index.json
2424
env:
25-
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
25+
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY2 }}

src/Dax.Vpax.CLI/README.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,41 @@
1+
# Dax.Vpax.CLI
2+
13
This is a .NET tool that provides CLI access to [VertiPaq-Analyzer](https://github.com/sql-bi/VertiPaq-Analyzer) functions.
24

35
Operations supported by this tool are:
46

57
- Export a VPAX file from a tabular model.
68

9+
## How to install the tool
10+
711
The tool can be installed using the following command:
812

9-
```shell
10-
dotnet tool install -g Dax.Vpax.CLI
13+
````bash
14+
dotnet tool install Dax.Vpax.CLI --global
15+
````
16+
17+
## How to run the tool
18+
19+
````bash
20+
vpax export "C:\output\file.vpax" "Provider=MSOLAP;Data Source=<SERVER>;Initial Catalog=<DATABASE>"
21+
````
22+
23+
Use `vpax -?` or `vpax export -?` to learn more.
24+
1125
```
26+
Description:
27+
Export a VPAX file from a tabular model
28+
29+
Usage:
30+
vpax export <path> <connection-string> [options]
1231
13-
After installing you can invoke the tool using the `vpax` command. Use `vpax -?` to learn more.
32+
Arguments:
33+
<path> Path to write the VPAX file
34+
<connection-string> Connection string to the tabular model
35+
36+
Options:
37+
--overwrite Overwrite the VPAX file if it already exists [default: False]
38+
--exclude-bim Exclude the BIM model (Model.bim) from the export [default: False]
39+
--exclude-vpa Exclude the VPA model (DaxVpaView.json) from the export [default: False]
40+
-?, -h, --help Show help and usage information
41+
```

0 commit comments

Comments
 (0)