Skip to content

dylan-robins/remote_target

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues Release date MIT License


Remote Target

A tool for automating software deployments and directory replication over sftp

Table of Contents
  1. About The Project
  2. Installation
  3. Installing from source
  4. Usage
  5. Contributing
  6. License

About The Project

remote_target lets you synchronize project directories to remote machines via SFTP on a per-project basis. This is done using a .remote_target file in the project root which specifies the hostname, connection information and remote directory to push to.

remote_target usage example

(back to top)

Installation

To simply install remote_target on a Linux machine, head on over to the releases and download the latest binary for your platform, and place it in a directory that's accessible in your path (for example ~/.local/bin). That's it!

If a prebuilt binary isn't available for your platform yet, you can install from source using the instructions below.

Installing from source

To install from source, follow the instructions below:

Prerequisites

In order to build the tool you'll need to install the following tools:

Installation

  1. Clone the repo
    git clone https://github.com/dylan-robins/remote_target.git
    cd remote_target
    
  2. Install Python library dependencies
    poetry install
    
  3. Build the project
    poetry build
    
  4. Install the library
    pip install --user dist/remote_target*.whl
    

(back to top)

Usage

usage: remote_target [-h] {info,init,push} ...

A tool for automating software deployments and directory replication over sftp

optional arguments:
  -h, --help        show this help message and exit

subcommands:
  {info,init,push}
    info            Displays information about the current remote_target configuration
    init            Initializes a .remote_target file in the current working directory
    push            Pushes the local files to the remote target

Example usage:
remote_target usage example

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENCE.txt for more information.

(back to top)

About

A tool for automating software deployments and directory replication over sftp

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages