-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlive_dev_porter.core.yml
214 lines (213 loc) · 6.67 KB
/
live_dev_porter.core.yml
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
title: 'Live Dev Porter'
name: 'Live Dev Porter'
description: 'Simplifies the management and transfer of assets between website environments.'
version: 0.0.172
author: 'Aaron Klump <[email protected]>'
additional_config:
- '$CLOUDY_BASEPATH/.live_dev_porter/config.yml'
- '$CLOUDY_BASEPATH/.live_dev_porter/config.local.yml'
additional_bootstrap: null
default_command: help
max_database_rollbacks_to_keep: 5
backup_remote_db_on_push: true
delete_pull_dumpfiles: true
compress_dumpfiles: true
# https://aboutnetworks.net/scp-macos13/
shell_commands:
scp: 'scp -O'
gzip: gzip
mysql: mysql
mysqldump: mysqldump
plugins:
mysql:
mysqldump_base_options:
- single-transaction
- skip-lock-tables
- no-tablespaces
commands:
version:
require_remote_env: false
help: Display the installed version of Live Dev Porter
remote:
require_remote_env: true
help: 'Enter the remote server shell.'
arguments:
remote_environment:
help: 'Optional. The ID of a remote environment. Defaults to the configured "remote".'
options:
verbose:
type: boolean
help: 'Run in verbose mode; helps troubleshoot connections.'
aliases:
- v
help:
help: 'Show this help screen.'
info:
help: 'Print the configuration info.'
pull:
require_remote_env: true
require_write_access: true
help: 'Pull remote database and files to local.'
arguments:
source:
help: 'Optional. The source environment to pull from; defaults to the configured remote.'
options:
skip-local-backup:
type: boolean
help: Use with caution; the local database backup will be skipped. The local db will be overwritten.
workflow:
type: string
aliases:
- wf
help: 'A workflow to use for the pull; this will be used instead of the configured default.'
verbose:
type: boolean
help: 'Output additional information.'
aliases:
- v
database:
type: boolean
help: 'Only pull the database.'
aliases:
- d
files:
type: boolean
help: 'Only pull the files.'
aliases:
- f
group:
type: string
help: 'Limit the operation by group'
dry-run:
type: boolean
help: 'Preview which files will be copied.'
push:
require_remote_env: true
require_remote_write_access: true
help: 'Push local database and files to remote.'
arguments:
remote_id:
help: 'Optional. The remote environment to push to; defaults to the configured remote.'
options:
verbose:
type: boolean
help: 'Output additional information.'
aliases:
- v
database:
type: boolean
help: 'Only push the database.'
aliases:
- d
files:
type: boolean
help: 'Only push the files.'
aliases:
- f
group:
type: string
help: 'Limit the operation by group'
dry-run:
type: boolean
help: 'Preview which files will be copied.'
import:
require_write_access: true
help: 'Import a dumpfile to the local database.'
arguments:
filepath:
help: 'A an absolute (or relative to the working directory) path to an existing export file. Alternately, it may be a portion of a filename used to search through existing files, or simply omitted and you will be shown files to choose from.'
options:
id:
type: string
help: 'Indicate the database ID to import into, this can be omitted when only one database is defined, or when you want the first (default) database to be used.'
export:
help: 'Export the local database.'
arguments:
filename:
help: 'Optional filename to use instead of the default, e.g., "rollback". Do not include the extension.'
options:
id:
type: string
help: 'Indicate the database ID to export, this can be omitted when only one database is defined, or when you want the first (default) database to be used.'
workflow:
type: string
aliases:
- wf
help: 'A workflow to use for export; this will be used instead of the configured default.'
dir:
type: string
help: 'Optional. An absolute path to an alternate, existing directory where the file will be saved.'
format:
type: string
enum:
- json
help: 'Use an alternate format, e.g. --format=json. Prints the absolute path to the export string.'
force:
type: boolean
help: 'Use force to overwrite an existing file, otherwise export will fail.'
uncompressed:
type: boolean
help: 'Do not compress the dumpfile.'
db:
help: 'Enter the local database shell.'
aliases:
- mysql
arguments:
id:
help: 'Use to enter a database other than the first/default listed for the local environment.'
config:
help: 'Get or set a single config value, e.g. "local" or open configuration for editing'
arguments:
name:
help: 'Optional variable name, if getting or setting a single value.'
value:
help: 'Optional, only use when setting a single value.'
options:
local:
type: boolean
help: 'Use this to open config.local.yml instead of config.yml.'
aliases:
- l
config-fix:
help: Fix common configuration problems, such as missing or stale cached configuration files.
aliases:
- configfix
- fix-config
- fixconfig
config-test:
help: 'Run tests to validate configuration.'
aliases:
- configtest
- health
config-migrate:
help: 'Migrate from Loft Deploy configuration.'
arguments:
loft_deploy:
help: 'Optional. The path to the .loft_deploy directory with the old configuration. A sibling directory .live_dev_porter will be created. Defaults to looking in the current directory.'
init:
help: 'Initialize local configuration files.'
options:
version:
help: 'Display the current version'
type: boolean
clear-cache:
aliases:
- clearcache
- cc
help: 'Clear all cached data.'
process:
help: 'Execute a single workflow processor in a controlled environment.'
arguments:
processor:
help: 'The value as you would add it to a workflow (basename or class::method).'
options:
config:
type: boolean
help: 'Edit the environment variables sent to the processor.'
aliases:
- c
workflow:
type: string
aliases:
- wf
help: 'Limit processor selection to this workflow.'