README.md

Welcome

Step CI is an open-source framework, which helps you automate API testing and monitoring

• Language-agnostic. Configure easily using YAML
• REST, GraphQL, gRPC. Test different API types at once
• Self-hosted. Test services on local network
• Integrated. Play nicely with others

→ Read the Docs

→ Try the Online Playground

→ Join us on GitHub Discussions

Get started

1. Install the CLI from NPM

   npm install -g stepci

   Note: Make sure you're using the LTS version of Node.js

2. Create example workflow

   workflow.yml

   version: "1.1"
   name: Status Check
   env:
     host: example.com
   tests:
     example:
       steps:
         - name: GET request
           http:
             url: https://${{env.host}}
             method: GET
             check:
               status: /^20/

   Note: You can also also use JSON format to configure your workflow

3. Run the workflow

   stepci run workflow.yml

   PASS  example
   
   Tests: 0 failed, 1 passed, 1 total
   Steps: 0 failed, 1 passed, 1 total
   Time:  0.559s, estimated 1s
   
   Workflow passed after 0.559s
   

Documentation

Documentation is available on docs.stepci.com

Examples

You can find example workflows under examples/

License

The source code is distributed under Mozilla Public License terms

Privacy