Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Alloy] Add CLI tools for inspecting and interacting with the Alloy API #377

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

chrismytton
Copy link
Member

Adds a couple of command line tools for inspecting designs in an Alloy instance, and interacting with the Alloy API via the methods in the AlloyV2 module.

  • bin/alloy/inspect-designs - Lets you view one or all designs in a given Alloy instance and shows attributes, their types and whether they're required in a text format.
  • bin/alloy/invoke - Allows you to call methods in the AlloyV2 module from the command line and pass parameters in via JSON. Inspired by the bin/fixmystreet.com/call-wasteworks-backend tool in FMS.

Allows you to either view all designs, or just one, and shows all attributes, their types and whether they're required or not.
Add command line interface for making Alloy API calls with configurable parameters.

This utility makes it easier to interact with the AlloyV2 class from the command line.
@chrismytton
Copy link
Member Author

@MorayMySoc These might be useful for Bristol. Once you've got an API key you should be able to put it into a config file and then use the inspect-designs script to get details about the design, what the attributes are, attribute types and whether they're required or not.

And then when you're working on the integration the invoke script might come in handy when you need to see what the code is doing/seeing.

Copy link
Contributor

@MorayMySoc MorayMySoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works well for me - thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants