@snowplow/snowplow-cli-win32-arm64 0.0.10 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -2
- package/bin/snowplow-cli.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,11 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
Snowplow CLI is available for [Snowplow BDP](https://docs.snowplow.io/docs/feature-comparison/) clients
|
|
8
8
|
|
|
9
|
-
## Documentation
|
|
9
|
+
## Documentation
|
|
10
|
+
|
|
10
11
|
Documentation for snowplow-cli is available over [here](https://docs.snowplow.io/docs/understanding-tracking-design/managing-your-data-structures/cli/)
|
|
11
12
|
|
|
12
13
|
## Installation
|
|
14
|
+
|
|
13
15
|
snowplow-cli can be installed with [homebrew](https://brew.sh/)
|
|
16
|
+
|
|
14
17
|
```
|
|
15
18
|
brew install snowplow/taps/snowplow-cli
|
|
16
19
|
snowplow-cli --help
|
|
@@ -26,18 +29,28 @@ chmod u+x snowplow-cli
|
|
|
26
29
|
./snowplow-cli --help
|
|
27
30
|
```
|
|
28
31
|
|
|
32
|
+
We also publish to [npm](https://www.npmjs.com/package/@snowplow/snowplow-cli)
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx @snowplow/snowplow-cli --help
|
|
36
|
+
```
|
|
37
|
+
|
|
29
38
|
## Configuration
|
|
30
|
-
|
|
39
|
+
|
|
40
|
+
Snowplow CLI requires configuration to use most of its functionality
|
|
31
41
|
|
|
32
42
|
### Create a config file
|
|
43
|
+
|
|
33
44
|
- Unix/Darwin: `mkdir -p ~/.config/snowplow && touch $HOME/.config/snowplow/snowplow.yml`
|
|
34
45
|
<!-- TODO: Windows -->
|
|
35
46
|
|
|
36
47
|
### Minimal configuration
|
|
48
|
+
|
|
37
49
|
You will need to provide the console organization id, API key and API secret.
|
|
38
50
|
You can find the instructions on how to get the API key and secret in the [documentation](https://docs.snowplow.io/docs/using-the-snowplow-console/managing-console-api-authentication/#credentials-ui-v3)
|
|
39
51
|
|
|
40
52
|
Your `snowplow.yml` content should look like following
|
|
53
|
+
|
|
41
54
|
```yaml
|
|
42
55
|
console:
|
|
43
56
|
org-id: ********-****-****-****-************
|
package/bin/snowplow-cli.exe
CHANGED
|
Binary file
|
package/package.json
CHANGED