Skip to content

Commit ea27ef6

Browse files
committed
Removed sh where it wasn't needed
1 parent 4f54cce commit ea27ef6

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ The Quickbase CLI is an open source project supported by the community, and it d
3232

3333
We recommend using [Homebrew](https://brew.sh/) to install the Quickbase CLI.
3434

35-
```sh
35+
```
3636
brew tap quickbase/tap
3737
brew install quickbase-cli
3838
```
3939

4040
Verify the installation:
4141

42-
```sh
42+
```
4343
quickbase-cli version
4444
```
4545

@@ -51,7 +51,7 @@ Download and extract the latest release for your platform from the [Releases](ht
5151

5252
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`:
5353

54-
```sh
54+
```
5555
git clone https://github.com/QuickBase/quickbase-cli.git
5656
cd ./quickbase-cli
5757
make
@@ -63,7 +63,7 @@ Run `make` in favor of `go build` because the version is set through linker flag
6363

6464
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.
6565

66-
```sh
66+
```
6767
quickbase-cli config setup
6868
```
6969

@@ -84,8 +84,11 @@ The `default` profile is used unless the `QUICKBASE_PROFILE` environment variabl
8484

8585
Run the following command to dump the configuration values for the active profile:
8686

87-
```sh
87+
```
8888
quickbase-cli config dump
89+
```
90+
91+
```json
8992
{
9093
"realm_hostname": "example1.quickbase.com",
9194
"user_token": "b3b6se_mzif_dy36********************hi7b",
@@ -110,7 +113,7 @@ quickbase-cli records delete --where '6="Another Record"'
110113

111114
Commands follow the traditional `APP COMMANDS ARGS --FLAGS` pattern. See the exmaple command below that gets an app definition:
112115

113-
```sh
116+
```
114117
quickbase-cli app get --app-id bqgruir3g
115118
```
116119

@@ -135,7 +138,7 @@ quickbase-cli app get --app-id bqgruir3g
135138

136139
Example command that queries for records, returning fields 6 throguh 8 where Record #ID equals 2:
137140

138-
```sh
141+
```
139142
quickbase-cli records query --select 6,7,8 --from bqgruir7z --where '{3.EX.2}'
140143
```
141144
@@ -191,13 +194,13 @@ In the examples above, `--select 6:8` is equivalent to `--select 6,7,8`. You can
191194

192195
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:
193196

194-
```sh
197+
```
195198
quickbase-cli records query --select 6:8 --from bqgruir7z --where '6="Record Two" 7=2'
196199
```
197200

198201
Just passing a number will find a record by its ID:
199202

200-
```sh
203+
```
201204
quickbase-cli records query --select 6:8 --from bqgruir7z --where 2
202205
```
203206

@@ -219,7 +222,7 @@ Other valid options for `--format` are `csv`, `markdown`.
219222

220223
Example command that creates a record where field 6 equals "Another Record" and field 7 equals 3:
221224

222-
```sh
225+
```
223226
quickbase-cli records insert --to bqgruir7z --data '6="Another Record" 7=3'
224227
```
225228

@@ -240,7 +243,7 @@ quickbase-cli records insert --to bqgruir7z --data '6="Another Record" 7=3'
240243

241244
Example commands that export data from one table and import it into another that has a similar structure:
242245

243-
```sh
246+
```
244247
quickbase-cli table export bq67er5pj | quickbase-cli table import bq72kz6p8
245248
```
246249

@@ -250,7 +253,7 @@ Use the import command's `--map` option to reconcile field label differences bet
250253

251254
Example commmand that deletes the record created above:
252255

253-
```sh
256+
```
254257
quickbase-cli records delete --from bqgruir7z --where '6="Another Record"'
255258
```
256259

@@ -264,7 +267,7 @@ quickbase-cli records delete --from bqgruir7z --where '6="Another Record"'
264267

265268
Example commmand that creates a relationship:
266269

267-
```sh
270+
```
268271
quickbase-cli relationship create --child-table-id bqgruir7z --parent-table-id bq6qbvfbv --lookup-field-ids 6,7
269272
```
270273

@@ -297,21 +300,21 @@ quickbase-cli relationship create --child-table-id bqgruir7z --parent-table-id b
297300

298301
Example command that runs a formula:
299302

300-
```sh
303+
```
301304
quickbase-cli formula run bck7gp3q2 1 --formula "Sum([NumericField],20)"
302305
```
303306

304307
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:
305308

306-
```sh
309+
```
307310
cat ./formula.qb | quickbase-cli formula run bck7gp3q2 1
308311
```
309312

310313
### Transforming Output
311314

312315
[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:
313316

314-
```sh
317+
```
315318
quickbase-cli table list --app-id bqgruir3g --filter "tables[].name | sort(@) | {Tables: join(', ', @)}"
316319
```
317320

0 commit comments

Comments
 (0)