minas-cli

🚀 Minas CLI

Minas is a zero-configuration, secure Network Attached Storage (NAS) application that you can launch instantly from your terminal. It allows you to securely share and manage your local files over the internet with zero network setup.

✨ Features

• Zero Config: No port forwarding or complex network setup required.
• Secure Tunnel: Automatically uses an SSH tunnel to create a secure public URL.
• Instant Access: Prints a QR Code in the terminal for immediate mobile access.
• Protected: Password-protected access with JWT session management.
• Rate Limited: Built-in login rate-limiting to prevent brute force attacks.
• Large File Support: Safely upload files up to 10GB per request.
• Mobile Friendly: Modern, responsive, glassmorphic web dashboard.
• File Management: Upload, download, create folders, and delete files from anywhere.

🚀 Quick Start

Launch Minas directly without installing using npx:

npx minas-cli

Note: On your first run, you will be prompted to set up a master password.

Once started:

• Copy the URL or Scan the QR Code printed in your terminal.
• Access your files securely from anywhere in the world!

🛠️ Installation (Global)

If you want to use it frequently, you can install it globally to your system:

npm install -g minas-cli

Setup Master Password

Before starting the server, configure your master password:

minas-cli config password

Start the Server

minas-cli

💻 Local Development

• Clone the repository:

  git clone https://github.com/CoriumCake/minas-cli.git
  cd minas-cli
  

• Install dependencies:

  npm install
  

• Run the development server:

  npm run dev
  

🔒 Security

• Your password is never stored in plain text (hashed via bcrypt).
• All file operations are protected by secure JWT authentication.
• Detailed Content Security Policy (CSP) headers enabled via Helmet.
• Strict path sanitization limits access to prevent directory traversal attacks.
• Only the configured storage directory is exposed.

📄 License

ISC License