@abruncloud/cli 0.1.4 → 0.2.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 DELETED
@@ -1,210 +0,0 @@
1
- # Abrun CLI
2
-
3
- Command line tools for managing Abrun projects, apps, deployments, databases, and tokens.
4
-
5
- ```sh
6
- npm install -g @abruncloud/cli
7
- ```
8
-
9
- After installation, the `abrun` command is available globally:
10
-
11
- ```sh
12
- abrun --help
13
- ```
14
-
15
- ## Login
16
-
17
- Start with browser-based login:
18
-
19
- ```sh
20
- abrun login
21
- ```
22
-
23
- You can also use an API token for automation:
24
-
25
- ```sh
26
- ABRUN_TOKEN=abrn_... abrun apps
27
- ```
28
-
29
- Useful auth commands:
30
-
31
- ```sh
32
- abrun whoami
33
- abrun logout
34
- abrun auth list
35
- abrun auth use <auth>
36
- abrun auth remove <auth>
37
- ```
38
-
39
- ## Projects
40
-
41
- Select the project you want commands to use by default:
42
-
43
- ```sh
44
- abrun project list
45
- abrun project use <project>
46
- abrun project current
47
- ```
48
-
49
- You can override the selected project per command:
50
-
51
- ```sh
52
- abrun --project <project> apps
53
- ```
54
-
55
- ## Apps
56
-
57
- Create and manage applications:
58
-
59
- ```sh
60
- abrun app create <name>
61
- abrun apps
62
- abrun app inspect <app>
63
- abrun app start <app>
64
- abrun app stop <app>
65
- abrun app restart <app>
66
- abrun app logs <app> --follow
67
- abrun app shell <app>
68
- abrun app delete <app>
69
- ```
70
-
71
- Deploy source from the current directory:
72
-
73
- ```sh
74
- abrun deploy <app>
75
- ```
76
-
77
- Deploy source from another path:
78
-
79
- ```sh
80
- abrun deploy <app> ./path/to/source
81
- ```
82
-
83
- Deploy an existing image:
84
-
85
- ```sh
86
- abrun deploy <app> --image registry.example.com/app:latest
87
- ```
88
-
89
- Common deploy flags:
90
-
91
- ```sh
92
- abrun deploy <app> --port 3000
93
- abrun deploy <app> --message "Release checkout fixes"
94
- abrun deploy <app> --logs
95
- ```
96
-
97
- Deployment commands:
98
-
99
- ```sh
100
- abrun app deployment list <app>
101
- abrun app deployment inspect <app> <deployment>
102
- abrun app deployment logs <app> <deployment>
103
- abrun app deployment watch <app> <deployment>
104
- abrun app deployment cancel <app> <deployment>
105
- abrun app deployment redo <app> <deployment>
106
- ```
107
-
108
- ## App Settings
109
-
110
- Environment variables:
111
-
112
- ```sh
113
- abrun app env list <app>
114
- abrun app env set <app> KEY=VALUE
115
- abrun app env unset <app> KEY
116
- ```
117
-
118
- Domains:
119
-
120
- ```sh
121
- abrun app domain list <app>
122
- abrun app domain add <app> <hostname>
123
- abrun app domain verify <app> <hostname>
124
- abrun app domain check <app> <hostname>
125
- abrun app domain delete <app> <hostname>
126
- ```
127
-
128
- Disks:
129
-
130
- ```sh
131
- abrun app disk list <app>
132
- abrun app disk create <app> <name> --size <gb>
133
- abrun app disk mount <app> <disk> <mountPath>
134
- abrun app disk unmount <app> <disk>
135
- abrun app disk expand <app> <disk> --size <gb>
136
- abrun app disk delete <app> <disk>
137
- ```
138
-
139
- ## Databases
140
-
141
- Create and manage databases:
142
-
143
- ```sh
144
- abrun db create <name>
145
- abrun dbs
146
- abrun db inspect <database>
147
- abrun db start <database>
148
- abrun db stop <database>
149
- abrun db logs <database> --follow
150
- abrun db credentials <database> --show-password
151
- abrun db delete <database>
152
- ```
153
-
154
- Open a local TCP tunnel to a database:
155
-
156
- ```sh
157
- abrun db tunnel <database> --port 5432
158
- ```
159
-
160
- Backups:
161
-
162
- ```sh
163
- abrun db backup list <database>
164
- abrun db backup create <database>
165
- ```
166
-
167
- ## Tokens
168
-
169
- Manage personal access tokens:
170
-
171
- ```sh
172
- abrun token list
173
- abrun token create <name>
174
- abrun token delete <token>
175
- ```
176
-
177
- ## Output And Flags
178
-
179
- Global flags:
180
-
181
- ```sh
182
- abrun --endpoint <url> <command>
183
- abrun --auth <auth> <command>
184
- abrun --project <project> <command>
185
- abrun --token <token> <command>
186
- abrun --json <command>
187
- abrun -o json <command>
188
- abrun -o yaml <command>
189
- ```
190
-
191
- Saved CLI context lives at:
192
-
193
- ```text
194
- ~/.abrun/config.yaml
195
- ```
196
-
197
- ## Help
198
-
199
- Every command has built-in help:
200
-
201
- ```sh
202
- abrun --help
203
- abrun app --help
204
- abrun deploy --help
205
- abrun db --help
206
- ```
207
-
208
- ## Package
209
-
210
- This package publishes the built Node.js runtime for the `abrun` command. TypeScript source, tests, source maps, and development configuration are not included in the npm tarball.