packaide is a CLI library that package your files defined in config. You can use it to package your source or upload to the host.

Report Bug · Request Feature

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Commands
• Configuration
• Usage Example
• Contributing
• License

About

I was developing an app with Laravel and deployment was taking too much time then I decided to make a library which is do the extra work for me.

Of course you can use the library with whatever you want.

Getting Started

Prerequisites

You must install one of these package managers npm or yarn.

Installation

npm

npm install packaide -D

yarn

yarn add packaide -D

Make sure you installing the package as devDependency.

Also you can install the CLI as global to use it everywhere, but it's not designed to use it that way. It could be challenging.

Commands

Parent command

packaide

Command		Description	Options
config		Shows config help.
config -s <key> <value>		Set config property with given value. (seperate values with "," for arrays.) packaide -s files .env,tsconfig.json,package.json	outputPath folders archiveAfterCopy archiveName files ftp.server ftp.username ftp.password ftp.sftp ftp.port ftp.deleteRemote ftp.include ftp.exclude ftp.exclude ftp.forcePassiveMode ftp.remoteRoot
config -dc		Creates default .packaide.json in your project root folder. Prompts yes/no if already exists to override current config.
copy		Start packaging.
upload		Start uploading to target server.

Configuration

Key	Type	Description
outputPath	string	Destination folder for files to copy.
folders	array	Folders to copy.
files	array	Filesto copy.
archiveAftercopy	boolean	If setted as true an archive file will be created in your project root after copy process.
archiveName	string	Archive file name.
FTP Settings
ftp	object	Ftp config.
ftp.server	string	FTP Server IP address.
ftp.username	string	FTP Username.
ftp.password	string	FTP Password.
ftp.port	number	FTP Password.
ftp.sftp	boolean	SFTP mode on/off.
ftp.deleteRemote	boolean	If setted as true packaide will delete remote files on the server.
ftp.include	array	Included file names or patterns for the files to upload.
ftp.excluded	array	Excluded file names or patterns for the files to upload.
ftp.forcePassiveMode	boolean	Passive mode.
ftp.remoteRoot	string	Remote FTP server upload path.

Usage Example

Example config file .packaide.json

{
  "outputPath": "release",
  "folders": [
    "./app",
    "./bootstrap",
    "./config",
    "./public",
    "./resources/views",
    "./resources/lang",
    "./routes",
    "./storage"
  ],
  "archiveAfterCopy": true,
  "archiveName": "packaide-release",
  "files": [".env", "composer.json", "composer.lock", ".production.env", "artisan"],
  "ftp": {
    "server": "127.0.0.7",
    "username": "ftpacc",
    "password": "S3CR3TP455W04RD",
    "sftp": false,
    "port": 21,
    "deleteRemote": false,
    "include": ["*", "**/*", ".env", ".production.env"],
    "exclude": [".local.env"],
    "forcePassiveMode": true,
    "remoteRoot": "/home/yourwebsite.com/public_html/"
  }
}

run packaide copy

Have fun :)

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

License

Distributed under the MIT License. See LICENSE.md for more information.