homeboy 0.17.0

CLI for multi-component deployment and development workflow automation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# `homeboy api`

## Synopsis

```sh
homeboy api <projectId> <COMMAND>
```

## Description

Make HTTP requests to a project’s configured API.

This command uses the project’s API configuration (`projects/<projectId>.json`) and any stored authentication (see `homeboy auth`).

## Subcommands

### `get`

```sh
homeboy api <projectId> get <endpoint>
```

### `post`

```sh
homeboy api <projectId> post <endpoint> [--body <json>]
```

### `put`

```sh
homeboy api <projectId> put <endpoint> [--body <json>]
```

### `patch`

```sh
homeboy api <projectId> patch <endpoint> [--body <json>]
```

### `delete`

```sh
homeboy api <projectId> delete <endpoint>
```

## Notes

- `<endpoint>` is passed through as provided (example: `/wp/v2/posts`).
- `--body` is parsed as JSON. If parsing fails, the request is sent with `body: null`.
- If `--body` is omitted, `body` is `null`.

## Output

JSON output is wrapped in the global envelope. `data` is the `homeboy::api::ApiOutput` struct.

## Related

- [auth](auth.md)
- [project](project.md)
- [JSON output contract](../json-output/json-output-contract.md)