doxx How to Use the pull Command

Syntax

$ doxx pull [doxx package name] [file URL] [shortcode]

Description

The pull command pulls files from remote sites to your local computer and automatically decompresses and unpacks them if necessary. It supports packages in the doxx Package Repository (by package name), text files (by URL), .gzip compressed files (by URL), tar.gz / zip archive files (by URL), and shortcodes for specific tasks (see below).

Usage

doxx will pull files that are accessible by GET request. http:// and https:// protocols are supported.

Beware:

Confirm that your build directory does not include files with the same file paths that are included in pulled, unpacked archives before you use doxx pull. doxx overwrites existing file paths with the new files when it unpacks archives. If you do not know the contents of the archive, pull into a clean, new project directory to avoid file loss.


Pull a Project from the doxx Package Repository

$ doxx pull [package name]

The current working directory is used as the root directory when directories and files are unpacked. Create a project directory and make this your working directory before you pull.


Pull tar.gz Project Archive

$ doxx pull [tar.gz archive URL]

The root directory is dependent upon how the developer packed the archive. The tar.gz archive file is removed after the project is unpacked.


Pull .zip Project Archive

$ doxx pull [.zip archive URL]

The root directory is dependent upon how the developer packed the archive. The zip archive file is removed after the project is unpacked.


Pull .gz Compressed File

$ doxx pull [.gzip file URL]

This works with files that have a .gz or .gzip file extension.


Pull Github Repository Master Branch with Shortcode

$ doxx pull [user]/[repository]

The repository directory is named [repository]-master. If this repository directory already exists, it is named [project]-master-new to avoid an overwrite. An existing directory on the path [project]-master-new are overwritten along with all contained files.


Pull Github Repository Branch or Release with Shortcode

$ doxx pull [user]/[repository][:branch]

The repository directory is named [repository]-[branch]. If this repository directory already exists, it is named [project]-[branch]-new to avoid an overwrite. An existing directory on the path [project]-[branch]-new are overwritten along with all contained files. By Github release naming convention, releases that use v.X.X.X tags will preserve the v. in the pulled directory branch name. Those that use vX.X.X tags, only include the digits in the directory branch name (i.e. X.X.X).


Cherry Pick Github Repository Directory with Shortcode

$ doxx pull [user]/[repository][+cherry-pick-path]

Use the relative path to the repository directory from the root of the remote repository.


Cherry Pick Github Repository File with Shortcode

$ doxx pull [user]/[repository][+cherry-pick-path]

Use the relative path to the repository file from the root of the remote repository


Cherry Pick a Github Repository File from a Branch or Release with Shortcode

$ doxx pull [user]/[repository][:branch][+cherry-pick-path]

Include the branch or release name after a colon character and the file (or directory) path relative to the root of the remote repository after the + character. Maintain the order of the branch and cherry pick path that is shown above.

Project archive specifications are available in the project archive documentation.

If you are working with local project files, the pack (docs) and unpack (docs) commands are available to create and unpack project archives, respectively.

The search command (docs) locates projects in the doxx Package Repository by keyword and project name.


just blimpin doxx documentation is licensed under the CC-4.0-Attribution LicenseImprove this page