Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomkyle/tuplo
tuplo is a CLI upload tool. It uses YAML files to describe upload targets and methods.
https://github.com/tomkyle/tuplo
cli upload
Last synced: about 13 hours ago
JSON representation
tuplo is a CLI upload tool. It uses YAML files to describe upload targets and methods.
- Host: GitHub
- URL: https://github.com/tomkyle/tuplo
- Owner: tomkyle
- License: mit
- Created: 2022-09-19T15:17:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T06:19:44.000Z (over 1 year ago)
- Last Synced: 2024-04-17T09:19:04.530Z (7 months ago)
- Topics: cli, upload
- Language: PHP
- Homepage:
- Size: 303 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tuplo
[](https://opensource.org/licenses/MIT) [](https://github.com/tomkyle/tuplo/actions/workflows/php.yml)
**tuplo is a CLI upload tool. It can be configured with YAML files. Currently, these upload methods are supported:**
- FTP
- SFTP with username/password
- SFTP with SSH key
---
## Installation
### Using Composer
Install *tuplo* as global command:
```bash
$ composer global require tomkyle/tuplo
```
Do not forget to make sure Composer’s global commands are available in `$PATH`:
```bash
# Unix, Linux, et al.
export PATH="/home/username/.config/composer/vendor/bin:${PATH}"
# MacOS
export PATH="/Users/you/.composer/vendor/bin:${PATH}"
```
### Linux, Unix et.al.
Grab repo content and install dependencies. You may want to symlink it in your `~/bin` directory:
```bash
$ git clone [email protected]:tomkyle/tuplo.git
$ cd tuplo
# Symlink if needed
$ ln -s "${PWD}/bin/tuplo" ~/bin/tuplo
```
### MacOS
**To be done, I'm working on it.**
---
## Configuration
Upload configurations can be stored in a `.tuplo.yaml` file, either in `$HOME` directory or in current work directory; with the latter preceding the first. See **[tuplo.dist.yaml](./tuplo.dist.yaml)** for examples – here an example for a plain old FTP upload. In this example, “typora” is the name of a single upload configuration, it is used as CLI parameter.
```yaml
typora:
description : Just a plain FTP example
method : ftp
downloadUrl : "https://test.com/typora"
host : 'ftp.test.com'
port : 21
ssl : false
root : 'path/to/typora'
username : 'ftp-username'
password : 'ftp-password'
```
---
## Usage
According to the above configuration sample, CLI usage goes like this.
```bash
$ tuplo typora [file] ...
```
---
## Development and testing
This repo contains **custom Git hooks** to automate *composer installs* after *composer.lock* has changed after *git pull*. Read more [here.](./git-hooks/README.md)
### Bugs and issues
Any hints are welcome and appreciated! Open a ticket on GitHub’s [issue tracker.](https://github.com/tomkyle/tuplo/issues)
### Unit tests
Default configuration is **[phpunit.xml.dist](./phpunit.xml.dist).** If you like, create a custom **phpunit.xml** to apply your own settings.
Also visit [phpunit.readthedocs.io](https://phpunit.readthedocs.io/) · [Packagist](https://packagist.org/packages/phpunit/phpunit)
```bash
$ composer phpunit
# ... or
$ vendor/bin/phpunit
```
### PhpStan
Default configuration is **[phpstan.neon.dist](./phpstan.neon.dist).** If you like, create a custom **phpstan.neon** to apply your own settings.
Also visit [phpstan.org](https://phpstan.org/) · [GitHub](https://github.com/phpstan/phpstan) · [Packagist](https://packagist.org/packages/phpstan/phpstan)
```bash
$ composer phpstan
# ... which includes
$ vendor/bin/phpstan analyse
```
### PhpCS
Default configuration is **[.php-cs-fixer.dist.php](./.php-cs-fixer.dist.php).** If you like, create a custom **.php-cs-fixer.php** to apply your own settings. Also visit [cs.symfony.com](https://cs.symfony.com/) · [GitHub](https://github.com/FriendsOfPHP/PHP-CS-Fixer) · [Packagist](https://packagist.org/packages/friendsofphp/php-cs-fixer)
```bash
$ composer phpcs
# ... which aliases
$ vendor/bin/php-cs-fixer fix --verbose --diff --dry-run
```
Apply all CS fixes:
```bash
$ composer phpcs:apply
# ... which aliases
$ vendor/bin/php-cs-fixer fix --verbose --diff
```