https://github.com/theforeman/hammer-cli

Next-gen CLI tool for foreman
https://github.com/theforeman/hammer-cli

hacktoberfest

Last synced: about 2 months ago
JSON representation

Next-gen CLI tool for foreman

• Host: GitHub
• URL: https://github.com/theforeman/hammer-cli
• Owner: theforeman
• License: gpl-3.0
• Created: 2012-04-23T16:46:21.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T14:41:29.000Z (4 months ago)
• Last Synced: 2024-05-22T14:47:32.951Z (4 months ago)
• Topics: hacktoberfest
• Language: Ruby
• Homepage:
• Size: 3.02 MB
• Stars: 98
• Watchers: 10
• Forks: 83
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Hammer - the CLI tool (not only) for Foreman

============================================

Hammer is a generic [clamp-based](https://github.com/mdub/clamp) CLI framework.

Hammer-cli provides just the core functionality. The core is extensible using plugins that contain application-specific commands.

This architecture allows for easy customization according to your application. Nearly any Ruby script can be turned into a Hammer command, so the possibilities are endless. You also can easily add custom commands for your specific use, such as bulk actions or admin tasks.

Available plugins are listed on [the Foreman's wiki](http://projects.theforeman.org/projects/hammer-cli/wiki/List_of_Plugins).

Check out the [release notes](doc/release_notes.md#release-notes) to see what's new in the latest version.

Installation

------------

We build rpms, debs and gems. Alternatively you can install hammer from a git checkout.

See our [installation and configuration instuctions](doc/installation.md#installation).

Having issues?

--------------

If one of hammer commands doesn't work as you would expect, you can run `hammer -d ...` to get

full debug output from the loggers. It should give you an idea what went wrong.

If you have questions, don't hesitate to contact us on `[email protected]` or

the `Freenode#theforeman` IRC channel.

Further reading

---------------

If you're interested in hammer and want to develop some plugins for Foreman

or use it as a base for your own CLI, read

[the developer docs](doc/developer_docs.md#hammer-development-docs).

License

-------

This project is licensed under the GPLv3+.

Acknowledgements

----------------

Thanks to Brian Gupta for the initial work and a great name.