cli.py
Command line entrypoint. This module declares the Copier CLI applications.
Basically, there are 3 different commands you can run:
-
copier
, the main app, which is a shortcut for thecopy
andupdate
subapps.If the destination project is found and has an answers file with enough information, it will become a shortcut for
copier update
.Otherwise it will be a shortcut for
copier copy
.Example
# Copy a new project copier gh:copier-org/autopretty my-project # Update it cd my-project copier
-
copier copy
, used to bootstrap a new project from a template.Example
copier copy gh:copier-org/autopretty my-project
-
copier update
to update a preexisting project to a newer version of its template.Example
copier update
Below are the docs of each one of those.
CopierApp
¶
Bases: cli.Application
The Copier CLI application.
Source code in copier/cli.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
|
CopierCopySubApp
¶
Bases: _Subcommand
The copier copy
subcommand.
Use this subcommand to bootstrap a new subproject from a template, or to override a preexisting subproject ignoring its history diff.
Source code in copier/cli.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
|
main(template_src, destination_path)
¶
Call run_copy.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
template_src |
str
|
Indicate where to get the template from. This can be a git URL or a local path. |
required |
destination_path |
str
|
Where to generate the new subproject. It must not exist or be empty. |
required |
Source code in copier/cli.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
|
CopierRecopySubApp
¶
Bases: _Subcommand
The copier recopy
subcommand.
Use this subcommand to update an existing subproject from a template that supports updates, ignoring any subproject evolution since the last Copier execution.
Source code in copier/cli.py
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
|
main(destination_path='.')
¶
Call run_recopy.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
destination_path |
cli.ExistingDirectory
|
Only the destination path is needed to update, because the
The subproject must exist. If not specified, the currently working directory is used. |
'.'
|
Source code in copier/cli.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
|
CopierUpdateSubApp
¶
Bases: _Subcommand
The copier update
subcommand.
Use this subcommand to update an existing subproject from a template that supports updates, respecting that subproject evolution since the last Copier execution.
Source code in copier/cli.py
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
|
main(destination_path='.')
¶
Call run_update.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
destination_path |
cli.ExistingDirectory
|
Only the destination path is needed to update, because the
The subproject must exist. If not specified, the currently working directory is used. |
'.'
|
Source code in copier/cli.py
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
|
handle_exceptions(method, *args, **kwargs)
¶
Handle keyboard interruption while running a method.
Source code in copier/cli.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
|