Score aims to improve developer productivity and experience by reducing the risk of configuration inconsistencies between local and remote environments. It provides developer-centric workload specification (score.yaml) which captures a workloads runtime requirements in a platform-agnostic manner.
The score.yaml specification file can be executed against a Score Implementation CLI, a conversion tool for application developers to generate environment specific configuration. In combination with environment specific parameters, the CLI tool can run your workload in the target environment by generating a platform-specific configuration file such as docker-compose.yaml or a Helm values.yaml. Learn more here.
To install score-compose, follow the instructions as described in our installation guide.
If you already have a score.yaml file defined, you can simply run the following command:
# Prepare a compose.yaml file
score-compose run -f /tmp/score.yaml -o /tmp/compose.yamlruntells the CLI to translate the Score file to a Docker Compose file.-fis the path to the Score file.--envspecifies the path to the output file.
If you're just getting started, follow this guide to run your first Hello World program with score-compose.
- Give the project a star!
- Contact us via Email:
- See our documentation.
- Write a blog post.
- Provide feedback on our road map and releases board.
- Contribute.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open an issue with the tag enhancement.
- Fork the Project.
- Create your Feature Branch.
git checkout -b feature/feature-name - Commit your Changes.
git commit -s -m "Add some AmazingFeature" - Push to the Branch.
git push origin feature/feature-name - Open a Pull Request.
Read CONTRIBUTING for more information.
You can find our documentation at docs.score.dev.
See Roadmap. You can submit an idea anytime.
