stepci-captured-runner

{tagline}

---

stepci-captured-runner Features

🚩 Table of Contents

• 💾 Install
• 🎮 Quick start
• 🚑 Community & support
• 🐋 Docker
• 🐝 API
• 🔧 Configuration
• 📋 Testing
• 🐛 Troubleshooting & debugging
• 😍 Acknowledgements
• 👤 Contributing
• 💼 License

---

💾 Install

bun i

🔝 back to top

---

🎮 Quick start

To start using stepci-captured-runner, follow these steps:

1. Build the executable:

   After installing the dependencies, you can build the project to generate the executable:

   bun i
   bun run build

   This will compile the source code and create the executable file in the dist directory.

2. Run the executable:

   After building, you can run the generated executable:

   ./dist/stepci-runner --path yourfile.yaml

   You can replace yourfile.yaml with the path to your StepCI YAML file.

3. Optional: Run directly with Bun:

   If you prefer not to build the executable, you can also run the project directly using Bun:

   bun run runner.js --path yourfile.yaml

   This will execute the script.js file without building the binary first.

🚀 Commands & Usage

• --path <file>: Specify the path to the test file.
• --secret <key=value...>: Provide secrets as key-value pairs.
• --env <key=value...>: Provide environment variables as key-value pairs.

For more information on using the available options, run:

stepci-runner --help

🔝 back to top

---

🚑 Community & support

📝 Documentation - Getting started and more.

🌱 Ecosystem - Plugins, resources, and more.

🚩 Issues - Bugs end errors you encounter using {project_name}.

💬 Discussions - Get help, ask questions, request features, and discuss {project_name}.

[] Matrix - Hanging out with the community.

🗣️ Discord - Hanging out with the community.

🪁 Telegram - Hanging out with the community.

📖 Example - An example repository that uses {project_name}.

🔝 back to top

😍 Acknowledgements

Copyleft 🄯 2023 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Mr. W. White for his special contributions.

🔝 back to top

---

👤 Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

1. 🔀 FORK IT
2. Create your feature branch git checkout -b feature/branch
3. Commit your changes git commit -am 'feat: New feature\ncloses #398'
4. Push to the branch git push origin feature/branch
5. Create a new Pull Request gh pr create -f
6. 🙏 Thank you

🔝 back to top

---

💼 License

{project_name} - {tagline}
Copyleft 🄯 2023 Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

🔝 back to top