puter-cli 1.0.0

package/.idx/dev.nix

@@ -0,0 +1,53 @@
+# To learn more about how to use Nix to configure your environment
+# see: https://developers.google.com/idx/guides/customize-idx-env
+{ pkgs, ... }: {
+  # Which nixpkgs channel to use.
+  channel = "stable-24.05"; # or "unstable"
+  # Use https://search.nixos.org/packages to find packages
+  packages = [
+    # pkgs.go
+    # pkgs.python311
+    # pkgs.python311Packages.pip
+    pkgs.nodejs_20
+    pkgs.nodePackages.nodemon
+  ];
+  # Sets environment variables in the workspace
+  env = {};
+  idx = {
+    # Search for the extensions you want on https://open-vsx.org/ and use "publisher.id"
+    extensions = [
+      # "vscodevim.vim"
+    ];
+    # Enable previews
+    previews = {
+      enable = true;
+      previews = {
+        # web = {
+        #   # Example: run "npm run dev" with PORT set to IDX's defined port for previews,
+        #   # and show it in IDX's web preview panel
+        #   command = ["npm" "run" "dev"];
+        #   manager = "web";
+        #   env = {
+        #     # Environment variables to set for your server
+        #     PORT = "$PORT";
+        #   };
+        # };
+      };
+    };
+    # Workspace lifecycle hooks
+    workspace = {
+      # Runs when a workspace is first created
+      onCreate = {
+        # Example: install JS dependencies from NPM
+        # npm-install = "npm install";
+        # Open editors for the following files by default, if they exist:
+        default.openFiles = [ ".idx/dev.nix" "README.md" ];
+      };
+      # Runs when the workspace is (re)started
+      onStart = {
+        # Example: start a background task to watch and re-build backend code
+        # watch-backend = "npm run watch-backend";
+      };
+    };
+  };
+}

package/LICENSE.md

@@ -0,0 +1,209 @@
+# Do No Harm License
+
+## 1. Preamble
+
+Most software today is developed with little to no thought of how it will be used, or the
+consequences for our society and planet.
+
+As software developers, we engineer the infrastructure of the 21st century. We recognise that our
+infrastructure has great power to shape the world and the lives of those we share it with, and we
+choose to consciously take responsibility for the social and environmental impacts of what we build.
+
+We envisage a world free from injustice, inequality, and the reckless destruction of lives and our
+planet. We reject slavery in all its forms, whether by force, indebtedness, or by algorithms that
+hack human vulnerabilities. We seek a world where humankind is at peace with our neighbours, nature,
+and ourselves. We want our work to enrich the physical, mental and spiritual wellbeing of all
+society.
+
+We build software to further this vision of a just world, or at the very least, to not put that
+vision further from reach.
+
+## 2. Definitions
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
+Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
+granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are
+controlled by, or are under common control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this
+License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to
+software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a
+Source form, including but not limited to compiled object code, generated documentation, and
+conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the
+License, as indicated by a copyright notice that is included in or attached to the work (an example
+is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
+derived from) the Work and for which the editorial revisions, annotations, elaborations, or other
+modifications represent, as a whole, an original work of authorship. For the purposes of this
+License, Derivative Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any
+modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity
+authorized to submit on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent to the Licensor or
+its representatives, including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor
+for the purpose of discussing and improving the Work, but excluding communication that is
+conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
+Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+"Forests" shall mean 0.5 or more hectares of trees that were either planted more than 50 years ago
+or were not planted by humans or human made equipment.
+
+"Deforestation" shall mean the clearing, burning or destruction of 0.5 or more hectares of forests
+within a 1 year period.
+
+## 3. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
+distribute the Work and such Derivative Works in Source or Object form.
+
+## 4. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer
+the Work, where such license applies only to those patent claims licensable by such Contributor that
+are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or
+a Contribution incorporated within the Work constitutes direct or contributory patent infringement,
+then any patent licenses granted to You under this License for that Work shall terminate as of the
+date such litigation is filed.
+
+## 5. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
+or without modifications, and in Source or Object form, provided that You meet the following
+conditions:
+
+1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+2. You must cause any modified files to carry prominent notices stating that You changed the
+   files; and
+
+3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+   patent, trademark, and attribution notices from the Source form of the Work, excluding those
+   notices that do not pertain to any part of the Derivative Works; and
+
+4. Neither the name of the copyright holder nor the names of its contributors may be used to endorse
+   or promote products derived from this software without specific prior written permission; and
+
+5. This software must not be used by any organisation, website, product, or service that:
+   1. promotes, lobbies for or derives a majority of income from:
+         1. **abuses of human rights**:
+            * human trafficking
+            * sex trafficking
+            * slavery or indentured servitude
+            * discrimination based on age, gender, gender identity, race, sexuality, religion, nationality
+            * hate speech
+         2. **environmental destruction**:
+            * the extraction or sale of fossil fuels
+            * the destruction of habitats for threatened or endangered species, including through deforestation or burning of forests
+            * the abuse, inhumane killing or neglect of animals under human control
+            * industrial processes that generate waste products that threaten life
+         3. **conflict and war**:
+            * warfare
+            * war crimes
+            * weapons manufacturing
+            * violence (except when required to protect public safety)
+         4. **addictive or destructive products and services**:
+            * gambling
+            * tobacco
+            * products that encourage adversely addictive behaviours
+
+   2. dissuades, lobbies against, or derives a majority of income from actions that discourage or frustrate:
+      * peace
+      * access to the rights set out in the [Universal Declaration of Human Rights](./documents/UDHR.md) and the [Convention on the Rights of the Child](./documents/CRC.md)
+      * democratic processes
+      * peaceful assembly and association (including worker associations)
+      * a sustainable environment
+   ; and
+   
+5. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
+   Works that You distribute must include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not pertain to any part of the
+   Derivative Works, in at least one of the following places: within a NOTICE text file
+   distributed as part of the Derivative Works; within the Source form or documentation, if
+   provided along with the Derivative Works; or, within a display generated by the Derivative
+   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
+   file are for informational purposes only and do not modify the License. You may add Your own
+   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
+   the NOTICE text from the Work, provided that such additional attribution notices cannot be
+   construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or
+different license terms and conditions for use, reproduction, or distribution of Your modifications,
+or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
+the Work otherwise complies with the conditions stated in this License.
+
+## 6. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
+Work by You to the Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed with Licensor regarding such
+Contributions.
+
+## 7. Trademarks
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product
+names of the Licensor, except as required for reasonable and customary use in describing the origin
+of the Work and reproducing the content of the NOTICE file.
+
+## 8. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties or conditions of
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+## 9. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or
+otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
+agreed to in writing, shall any Contributor be liable to You for damages, including any direct,
+indirect, special, incidental, or consequential damages of any character arising as a result of this
+License or out of the use or inability to use the Work (including but not limited to damages for
+loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+## 10. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
+consistent with this License. However, in accepting such obligations, You may act only on Your own
+behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting any such warranty or
+additional liability.
+
+## Attribution
+
+Do No Harm License [Contributor Covenant][homepage], (pre 1.0),
+available at https://github.com/raisely/NoHarm
+
+[homepage]: https://github.com/raisely/NoHarm

package/README.md

@@ -0,0 +1,292 @@
+# Puter-CLI
+
+The **Puter CLI** is a command-line interface tool designed to interact with the **Puter Cloud Platform**. It allows users to manage files, directories, applications, and other resources directly from the terminal. This tool is ideal for developers and power users who prefer working with command-line utilities.
+
+---
+
+## Features
+
+- **File Management**: Upload, download, list, and manage files and directories.
+- **Authentication**: Log in and log out of your Puter account.
+- **User Information**: Retrieve user details, such as username, email, and account status.
+- **Disk Usage**: Check disk usage and storage limits.
+- **Application Management**: Create, delete, and list applications hosted on Puter.
+- **Static Site Hosting**: Deploy static websites from directories.
+- **Interactive Shell**: Use an interactive shell for seamless command execution.
+- **Cross-Platform**: Works on Windows, macOS, and Linux.
+
+---
+
+## Installation
+
+### Prerequisites
+- Node.js (v16 or higher)
+- npm (v7 or higher)
+
+### Steps
+1. Clone the repository:
+ ```bash
+   git clone https://github.com/bitsnaps/puter-cli.git
+   cd puter-cli
+ ```
+2. Install dependencies:
+ ```bash
+   npm install
+ ```
+3. Link the CLI globally:
+ ```bash
+   npm link
+ ```
+
+---
+
+## Usage
+
+### Commands
+
+#### Authentication
+- **Login**: Log in to your Puter account.
+```bash
+  puter login
+```
+- **Logout**: Log out of your Puter account.
+```bash
+  puter logout
+```
+
+#### File Management
+
+We've adopted the most basic popluar linux system command line for daily file manipulation with some extra features, not out of the box though, we want to keep it simple.
+
+- **List Files**: List files and directories.
+```bash
+  puter> ls [dir]
+```
+- **Change Directory**: Navigate to a directory:
+```bash
+  puter> cd [dir]
+```
+It works with wildcards as you would expect in any OS for basic navigation with insensitive case: `cd ..`, `cd ../myapp`...etc.
+
+- **Create Directory**: Create a new directory.
+```bash
+  puter> mkdir <dir>
+```
+- **Copy Files**: Copy files or directories.
+```bash
+  puter> cp <src> <dest>
+```
+- **Move Files**: Move or rename files or directories.
+```bash
+  puter> mv <src> <dest>
+```
+- **Delete Files/Directories**: Move files or directories to the trash.
+```bash
+  puter> rm [-f] <file>
+```
+- **Empty Trash**: Empty the system's trash.
+```bash
+  puter> clean
+```
+##### Extra commands:
+
+Think of it as `git [push|pull]` commands, they're basically simplified equivalents.
+
+- **Push Files**: Copy files from host machine to the remote cloud instance.
+```bash
+  puter> push <host_src>
+```
+- **Pull Files**: Copy files from remote cloud instance to the host machine.
+```bash
+  puter> pull <remote_src>
+```
+P.S. These commands consider the current directory as the base path for every operation, basic wildcards are supported: e.g. `push myapp/*.html`.
+
+#### User Information
+- **Get User Info**: Display user information.
+```bash
+  puter whoami
+```
+
+#### Disk Usage
+- **Check Disk Usage**: Display disk usage information.
+```bash
+  puter df
+```
+- **Get Usage Info**: Fetch usage information for services.
+```bash
+  puter usage
+```
+
+#### Application Management
+
+The **Application** are sepcial type of hosted web app, they're served from the special directory at: `<USERNAME>/AppData/<UUID>...`, more details at **app:create** in the section below.
+
+- **List Applications**: List all applications.
+```bash
+  puter apps [period]
+```
+P.S. Please check the help command `help apps` for more details about any argument.
+
+- **Create Application**: Create a new application.
+```bash
+  puter app:create <name> [<remote_dir>] [--description=<description>] [--url=<url>]
+```
+P.S. By default a new `index.html` with basic content will be created, but you can set a directory when you create a new application as follows: `app:create nameOfApp ./appDir`, so all files will be copied to the `AppData` directoy, you can then update your app using `app:update <name> <remote_dir>`. This command will attempt to create a subdomain with a random `uid` prefixed with the name of the app.
+
+- **Update Application**: Update an application.
+```bash
+  puter app:update <name> <remote_dir>
+```
+**IMPORTANT** All existing files will be overwritten, new files are copied, other files are just ignored.
+
+- **Delete Application**: Delete an application.
+```bash
+  puter app:delete [-f] <name>
+```
+P.S. This command will lookup for the allocated `subdomain` and attempt to delete it if it exists.
+
+#### Static Sites
+
+The static sites are served from the selected directory (or the current directory if none is specified).
+
+- **Deploy Site**: Deploy a static website from a directory.
+```bash
+  puter site:create <dir> [--subdomain=<name>]
+```
+P.S. If the subdomain already exists, it will generate a new random one can set your own subdomain using `--subdomain` argument.
+
+- **List Sites**: List all hosted sites.
+```bash
+  puter sites
+```
+- **Delete Site**: Delete a hosted site.
+```bash
+  puter site:delete <uid>
+```
+P.S. You can find the `<uid>` in the list of `sites`.
+
+#### Interactive Shell
+- **Start Shell**: Launch an interactive shell.
+```bash
+  puter [shell]
+```
+or just type (you'll need to login):
+```bash
+  puter
+```
+
+#### Help
+- **General Help**: Display a list of available commands.
+```bash
+  puter help
+```
+- **Command Help**: Display detailed help for a specific command.
+```bash
+  puter help <command>
+```
+
+---
+
+## Examples
+
+1. **Log in and List Files**:
+ ```bash
+   puter login
+   puter> ls
+ ```
+
+2. **Create and Deploy a Static Site**:
+ ```bash
+   puter> mkdir my-site
+   puter> site:create my-site --subdomain=myapp
+ ```
+
+3. **Check Disk Usage**:
+ ```bash
+   puter> df
+ ```
+
+4. **Delete a File**:
+ ```bash
+   puter> rm /path/to/file
+ ```
+
+5. **Display statistics**:
+ ```bash
+   puter> stat /path/to/file/or/directory
+ ```
+
+---
+
+## Known issues:
+
+Most of the functionalities are just working fine, however some APIs related to Puter's SDK have some known issues. We tried to fix most them but some of them are not related to us, so we let you about that in case it'll be fixed by Puter's in the future:
+
+## Delete a subdomain
+When you try to delete a subdomain which you own, you'll get `Permission denied`:
+```bash
+Failed to delete subdomain: Permission denied.
+Site ID: "sd-b019b654-e06f-48a8-917e-ae1e83825ab7" may already be deleted!
+```
+However, the query is executed successfully at the cloud and the subdomain is actually deleted.
+
+## Interactive Shell prompt:
+If you want to stay in the interactive shell you should provide "-f" (aka: force delete) argument, when want to delete any object:
+```bash
+puter@username/myapp> rm README.md
+The following items will be moved to Trash:
+- /username/myapp/README.md
+? Are you sure you want to move these 1 item(s) to Trash? (y/N) n
+puter@username/myapp> Operation canceled.
+username:~/home$ puter
+puter@username/myapp> rm -f README.md
+Successfully moved "/username/myapp/README.md" to Trash!
+```
+Otherwise, the Interactive Shell mode will be terminated.
+
+---
+
+## Notes
+
+This project is not equivalent [phoenix](https://github.com/HeyPuter/puter/blob/main/src/phoenix/README.md), niether an attempt to mimic some it's features, it's rather a CLI tool to do most the Puter's API from command line.
+
+---
+
+## Configuration
+
+The CLI uses a configuration file to store user credentials and settings. By default, this file is located at `~/.config/puter-cli/config.json`. You can manually edit this file or use the `puter logout` to empty the file settings.
+
+---
+
+## Contributing
+
+We welcome contributions! Please follow these steps:
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix with a reproducible steps.
+3. Submit a pull request with a detailed description of your changes.
+
+---
+
+## License
+
+This project is licensed under the **[NoHarm License](https://github.com/raisely/NoHarm/blob/publish/LICENSE.md)**. See the [LICENSE](LICENSE.md) file for details.
+
+---
+
+## Support
+
+For issues or questions, please open an issue on [GitHub](https://github.com/bitsnaps/puter-cli/issues) or contact [puter's team](hey@puter.com) if you found an issue related to Puter's APIs.
+
+---
+
+## Acknowledgments
+
+- **Puter Cloud Platform** for providing the backend infrastructure.
+- **Node.js** and **npm** for enabling this project.
+- The open-source community for their invaluable contributions.
+
+---
+
+
+Happy deploing with **Puter CLI**! 🚀

package/bin/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { login, logout } from '../commands/auth.js';
+import { init } from '../commands/init.js';
+import { startShell } from '../commands/shell.js';
+
+const program = new Command();
+
+program
+  .name('puter')
+  .description('CLI tool for Puter cloud platform')
+  .version('1.0.0');
+
+program
+  .command('login')
+  .description('Login to Puter account')
+  .action(login);
+
+program
+  .command('logout')
+  .description('Logout from Puter account')
+  .action(logout);
+
+program
+  .command('init')
+  .description('Initialize a new Puter app')
+  .action(init);
+
+program
+  .command('shell')
+  .description('Start interactive shell')
+  .action(startShell);
+
+if (process.argv.length === 2) {
+  startShell();
+} else {
+  program.parse();
+}