Documentation

📖 1. Introduction

AutoForge is a modern DevOps automation tool designed to help teams automate:

CI/CD pipelines
Infrastructure provisioning
Secrets management
Monitoring setup

Built for speed, security, and scalability, AutoForge works across cloud providers and supports GitOps workflows out of the box.

🛠️ 2. Installation

🔧 Prerequisites

Node.js >= 18
Docker (optional, for container builds)
Git
A supported CI provider (GitHub Actions, GitLab CI, etc.)

📦 Install via NPM

npm install -g autoforge

Or use Docker:

docker run --rm -it autoforge/autoforge:latest

⚙️ 3. Configuration

AutoForge uses a single YAML configuration file:

# autoforge.yml project: my-app environment: staging pipeline: - lint - test - build - deploy notifications: slack: true

🗂️ File Structure

.
├── autoforge.yml
├── scripts/
│ ├── build.sh
│ ├── deploy.sh
├── .github/workflows/
│ └── ci.yml

🚀 4. Usage

🔁 Running the Pipeline

autoforge run

You can target specific steps:

autoforge run --steps=lint,test

📤 Deploy

autoforge deploy --env=production

🔧 5. CLI Reference

`autoforge init`

Initialize a new project:

autoforge init

`autoforge run`

Run all or some of the pipeline steps:

autoforge run --steps=build,test

`autoforge deploy`

Trigger a deployment:

autoforge deploy --env=staging

⚙️ 6. CI/CD Integration

AutoForge supports native CI/CD integration.

✅ GitHub Actions Example

# .github/workflows/ci.yml name: AutoForge CI on: push: branches: [ main ]

jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - run: npm install -g autoforge - run: autoforge run

🐞 7. Troubleshooting

Problem	Solution
`autoforge: command not found`	Ensure it's installed globally (`npm install -g autoforge`)
Pipeline step fails unexpectedly	Run with `--debug` to get detailed logs
Deployment hangs	Check SSH or cloud provider access credentials

❓ 8. FAQs

Q: Does AutoForge support multi-cloud?

Yes. You can define separate pipeline steps for AWS, GCP, and Azure.

Q: Is there a UI?

Not yet. It's currently CLI-only, with dashboard support planned in v1.2.

🙋 9. Support & Contributing

📬 Contact Support

Email: support@autoforge.dev
Slack: Join our Slack

🤝 Contribute

We welcome contributions!

Fork the repo
Create a new branch
Submit a pull request

See CONTRIBUTING.md for more info.