AutoFlow Documentation

Welcome to the official AutoFlow documentation. Here you'll find comprehensive guides and documentation to help you start working with AutoFlow as quickly as possible.

Installation

AutoFlow is distributed via npm, which implies you need to have Node.js installed in your environment. To install AutoFlow globally across your system, simply execute the following command in your favorite terminal:

npm install -g autoflow-tech

Verify that the installation was successful by checking the version:

autoflow --version

Setup

Once you have AutoFlow installed, navigate into an existing web project repository. AutoFlow utilizes intelligent heuristics to identify the framework driving your application (e.g., Next.js, React, Vue, Python/Django, Node.js).

Run the initialization sequence to safely set up your environment variables locally and configure deployment behaviors:

cd my-awesome-app
autoflow init

This generates a autoflow.json file representing your specific configuration options.

Commands

The AutoFlow CLI exposes an array of commands prioritizing minimalistic deployment operations.

Server Required

Before using AutoFlow, please ensure you have an active server (Cloud provider or VPS).

Essential Commands:

# Install and configure global dependencies autoflow setup
? Select your preferred cloud provider: AWS ? Enter your Access Key ID: ******************** ? Enter your Secret Access Key: **************************************** ? Default Region (e.g., us-east-1): us-east-1
✔ Global configuration securely saved.
# Initialize a new autoflow project locally autoflow init
? Enter GitHub Repository URL: https://github.com/Keval/my-awesome-app ℹ Cloning repository... ✔ Repository cloned successfully ℹ Scanning project directory... ✔ Next.js application detected ? Project Name: my-awesome-app ? Domain/Sub-domain: my-awesome-app.com ? Build Command: npm run build ? Production Directory: .next ? Port: 3000
✔ autoflow.json configuration file generated successfully.
# Deploy your application to the server autoflow deploy
# Check the real-time status of your deployment autoflow status
# Safely stop and spin down your application autoflow stop

Troubleshooting

If you face any issues preventing a successful setup or deployment, we highly recommend executing diagnostic traces natively:

autoflow doctor

This command securely analyzes your codebase constraints, DNS conflicts, and credential statuses mapping potential resolutions. In case problems persist, please visit our GitHub Discussions to reach our dedicated support network effortlessly.