{"id":28072202,"url":"https://github.com/xjectro/deloyn","last_synced_at":"2025-06-24T07:05:47.172Z","repository":{"id":292732960,"uuid":"976210137","full_name":"Xjectro/deloyn","owner":"Xjectro","description":"deloyn is a simple command-line tool to publish and deploy your project via SSH and SFTP under Node.","archived":false,"fork":false,"pushed_at":"2025-05-11T20:38:11.000Z","size":110,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-12T21:09:15.511Z","etag":null,"topics":["javascript","javascript-library","npm-module","npm-package","ssh-connection","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/deloyn","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Xjectro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-01T17:41:06.000Z","updated_at":"2025-05-11T20:38:15.000Z","dependencies_parsed_at":"2025-05-11T21:38:45.299Z","dependency_job_id":null,"html_url":"https://github.com/Xjectro/deloyn","commit_stats":null,"previous_names":["xjectro/deloyn"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xjectro%2Fdeloyn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xjectro%2Fdeloyn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xjectro%2Fdeloyn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xjectro%2Fdeloyn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Xjectro","download_url":"https://codeload.github.com/Xjectro/deloyn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253823442,"owners_count":21969847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","javascript-library","npm-module","npm-package","ssh-connection","typescript"],"created_at":"2025-05-12T21:09:24.084Z","updated_at":"2025-06-24T07:05:47.144Z","avatar_url":"https://github.com/Xjectro.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deloyn\n\nSSH Publish \u0026 Deploy CLI\n\ndeloyn is a simple command-line tool to publish and deploy your project via SSH and SFTP under Node.\n\n## Features\n\n- **Interactive confirmation before deployment**  \n  Before starting the publishing process, the user is prompted for confirmation, ensuring no accidental deployments.\n\n- **Configurable via `deloyn.config.js` or `deloyn.config.ts`**  \n  Easily configure deployment settings using JavaScript or TypeScript configuration files. Flexibility to define server details, source, and target directories.\n\n- **Exclude files and directories**  \n  Option to exclude specific files or directories from being published, giving you full control over what gets deployed.\n\n- **Adjustable batch size for uploads**  \n  Fine-tune the upload process with configurable batch sizes, allowing for optimized performance based on file sizes or network conditions.\n\n- **Spinner feedback for progress**  \n  Visual feedback during the publishing process, with a spinner to show that the deployment is in progress. Helps users understand the current state of the operation.\n\n- **TypeScript support with ESM**  \n  Full TypeScript support with ES modules (ESM), ensuring a smooth development experience with type safety and modern JavaScript features.\n\n- **SSH-based deployment**  \n  Securely deploy files over SSH to remote servers. The tool supports password authentication or SSH key-based authentication for a secure connection.\n\n- **Real-time error reporting**  \n  If any issues occur during the deployment, users receive immediate feedback with detailed error messages to aid troubleshooting.\n\n- **Automated update checks**  \n  The CLI automatically checks for new updates to ensure you're always using the latest features and security patches, with the option to update directly from the terminal.\n\n- **Environment-specific configurations**  \n  Define different configuration files for various environments (e.g., `config.production.js`, `config.staging.js`) to streamline deployments across multiple environments.\n\n- **Customizable deployment steps**  \n  Add custom commands or deployment steps before or after publishing (e.g., running tests, pre-deployment scripts), providing flexibility in the deployment workflow.\n\n- **Log file generation**  \n  Logs are generated during deployment, helping you keep track of what was deployed, any issues that arose, and a record of the process for auditing purposes.\n\n- **Support for multiple servers**  \n  Deploy to multiple remote servers at once with configurable server details in the config file. This is useful for scaling applications or deploying to different staging environments.\n\n- **Automatic retries on failure**  \n  In case of network interruptions or temporary failures, the CLI automatically retries failed uploads, ensuring reliable deployment even under less-than-ideal conditions.\n\n- **Versioning and changelogs**  \n  Track the version of each deployment and generate changelogs automatically based on your commit history or version tags, ensuring transparency and traceability for all deployed changes.\n\n- **Customizable output formatting**  \n  Customize the verbosity and format of the CLI output (e.g., silent, verbose, or minimal output) depending on your preference or environment.\n\n- **Support for symbolic links**  \n  Deploy symbolic links along with your files, ensuring that file references are preserved as intended in the deployment environment.\n\n- **Security enhancements**  \n  Features like automatic key rotation for SSH and encrypted deployment credentials in the configuration file to ensure the security of your deployment pipeline.\n\n## Installation\n\nInstall globally:\n\n```bash\nnpm install -g deloyn\n```\n\nOr use npx:\n\n```bash\nnpx deloyn push\n```\n\n## Usage\n\n```bash\ndeloyn push\n```\n\nAvailable Commands:\n\n- `push`   Start publishing (requires config file)\n  Start the publishing process by connecting to the remote server and uploading files.  \n  Usage:\n  ```bash\n  deloyn push\n  ```\n- `update`  Update deloyn CLI to latest version Update the deloyn CLI tool to the latest version available.\n  Usage:\n  ```bash\n  deloyn update\n  ```\n- `help`  Show help message Display the help message with all available commands and options.\n  Usage:\n  ```bash\n  deloyn help\n  ```\n- `-v` / `--version`  Show CLI version Show the current version of the deloyn CLI.\n  Usage:\n  ```bash\n  deloyn --version\n  ```\n\n## Configuration\n\nCreate a `deloyn.config.js` or `deloyn.config.ts` in your project root:\n\n```ts\n// deloyn.config.ts\nimport { defineConfig } from 'deloyn';\n\nexport default defineConfig({\n  serverIp: '1.2.3.4',        // Remote server IP\n  username: 'ubuntu',         // SSH username\n  remotePath: '/prod', // Path on remote server\n  sshKey: '~/.ssh/id_rsa',    // SSH private key path\n  excluded: [                 // Files or directories to exclude\n    '.git',\n    'node_modules',\n    'dist',\n    'README.md',\n  ],\n  batchSize: 5,               // Concurrent uploads per batch\n  localPath: process.cwd(),   // Local root path to upload\n  scripts: [                  // The commands are executed sequentially after deploy. It is up to you which package manager you use (pnpm, yarn, npm...).\n    \"npm install\",\n    \"npm run build\"\n  ]\n});\n```\n\n## License\n\nMIT © xjectro\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxjectro%2Fdeloyn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxjectro%2Fdeloyn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxjectro%2Fdeloyn/lists"}