score-humanitec

README

---

⚠ Deprecation Notice ⚠

The Humanitec CLI now supports Score natively and score-humanitec is deprecated. Checkout the docs on how to deploy with humctl.

---

Score overview

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. Learn more here.

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. The score-humanitec CLI is used to generate and deploy a Humanitec deployment delta.

Installation

To install score-humanitec, follow the instructions as described in our installation guide.

Get started

If you already have a score.yaml file defined, you can simply run the following command:

# Prepare a new Humanitec deployment delta
score-humanitec run -f ./score.yaml --env test-env

• run tells the CLI to translate the Score file to a Humanitec deployment delta.
• -f is the path to the Score file.
• --env specifies the environment ID.

If you're just getting started, follow this guide to run your first Hello World program with score-humanitec.

Get involved

• Give the project a star!
• Contact us via email:
  • team@score.dev
  • abuse@score.dev
• See our documentation

Contributing

• Write a blog post
• Provide feedback on our roadmap
• 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.

1. Fork the Project.
2. Create your Feature Branch. git checkout -b feature/feature-name
3. Commit your Changes. git commit -s -m "Add some AmazingFeature"
4. Push to the Branch. git push origin feature/feature-name
5. Open a Pull Request.

Read CONTRIBUTING for more information.

Documentation

You can find our documentation at docs.score.dev.

Roadmap

See Roadmap. You can submit an idea anytime.

License

Code of conduct