You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-16Lines changed: 19 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,14 +32,14 @@ The Quickbase CLI is an open source project supported by the community, and it d
32
32
33
33
We recommend using [Homebrew](https://brew.sh/) to install the Quickbase CLI.
34
34
35
-
```sh
35
+
```
36
36
brew tap quickbase/tap
37
37
brew install quickbase-cli
38
38
```
39
39
40
40
Verify the installation:
41
41
42
-
```sh
42
+
```
43
43
quickbase-cli version
44
44
```
45
45
@@ -51,7 +51,7 @@ Download and extract the latest release for your platform from the [Releases](ht
51
51
52
52
With a [correctly configured](https://golang.org/doc/install#install) Go toolchain, clone the repository to a directory of your choosing, change into it, and run `make`:
@@ -63,7 +63,7 @@ Run `make` in favor of `go build` because the version is set through linker flag
63
63
64
64
Configuration is read from command-line options, environment variables, and a configuration file in that order of precedence. You are advised to set up a configuration file using the command below, which will prompt for your realm hostname, user token, and an optional application ID.
65
65
66
-
```sh
66
+
```
67
67
quickbase-cli config setup
68
68
```
69
69
@@ -84,8 +84,11 @@ The `default` profile is used unless the `QUICKBASE_PROFILE` environment variabl
84
84
85
85
Run the following command to dump the configuration values for the active profile:
@@ -110,7 +113,7 @@ quickbase-cli records delete --where '6="Another Record"'
110
113
111
114
Commands follow the traditional `APP COMMANDS ARGS --FLAGS` pattern. See the exmaple command below that gets an app definition:
112
115
113
-
```sh
116
+
```
114
117
quickbase-cli app get --app-id bqgruir3g
115
118
```
116
119
@@ -135,7 +138,7 @@ quickbase-cli app get --app-id bqgruir3g
135
138
136
139
Example command that queries for records, returning fields 6 throguh 8 where Record #ID equals 2:
137
140
138
-
```sh
141
+
```
139
142
quickbase-cli records query --select 6,7,8 --from bqgruir7z --where '{3.EX.2}'
140
143
```
141
144
@@ -191,13 +194,13 @@ In the examples above, `--select 6:8` is equivalent to `--select 6,7,8`. You can
191
194
192
195
You can also use simplified query syntax for basic queries. The following command queries for records where field 6 equals "Record One" and field 7 equals 2:
quickbase-cli formula run bck7gp3q2 1 --formula "Sum([NumericField],20)"
302
305
```
303
306
304
307
Formulas can span multiple lines and get pretty large. In this instance, you can pass the formula via `STDIN` to this command. The following example assumes the `formula.qb` file contains a large formula:
305
308
306
-
```sh
309
+
```
307
310
cat ./formula.qb | quickbase-cli formula run bck7gp3q2 1
308
311
```
309
312
310
313
### Transforming Output
311
314
312
315
[JMESPath](https://jmespath.org/) is a powerful query language for JSON. You can apply JMESPath filters to transform the output of commands to make the data easier to work with. For example, let say you want to get only a list of table names in an app sorted alphabetically. To accomplish this, you can apply a JMESPath filter using the `--filter` option to the command below:
0 commit comments