catalog-cli's Introduction

catalog-cli

A CLI to interact with Napptive Catalog.

This component is the entry point into Napptive catalog.

Prerequisites

Component catalog-manager deployed

Commands

To interact with the catalog, we offer several commands in catalog-cli.

The catalog command provides a set of methods to interact with the Napptive Catalog

Usage:
 catalog [flags]
 catalog [command]

Examples:
$ catalog

Available Commands:
 help        Help about any command
 info        Get the principal information of an application.
 list        List the applications
 pull        Pull an application from catalog.
 push        Push an application in the catalog.
 remove      Remove an application from catalog.

Flags:
     --catalogAddress string   Catalog-manager host (default "catalog-manager")
     --catalogPort int         Catalog-manager port (default 7060)
     --consoleLogging          Pretty print logging
     --debug                   Set debug level
 -h, --help                    help for catalog
     --output string           Output format in which the results will be returned: json or table (default "table")
 -v, --version                 version for catalog

Use "catalog [command] --help" for more information about a command.

Layout structure

The layout structure is based on the default golang-template layout.

https://github.com/golang-standards/project-layout

Usage

A make file is provided with the following targets:

clean: Remove build files
test: Run the available tests
build: Build the files for your local environment
build-darwin: Build the files for MacOS
build-linux: Build the files for Linux
k8s: Generate the Kubernetes deployment files
docker-prep: Prepare the Dockerfile folder with all the extra files
docker-build: Build the Dockerfile locally
docker-push: Push the image to the selected repository. You must make login before to push the docker image.

Important

If you are developing with MacOS/Darwin, you must install gnu-sed.

brew install gnu-sed

Integration with Github Actions

This template is integrated with GitHub Actions. You need to add the secret CodeClimateRerporterID in the repository settings.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

catalog-cli's People

Contributors

Stargazers

catalog-cli's Issues

Spam email from Napptive

I received unsolicited spam mail from Napptive:

We have been scouting open source projects in order to provide core project contributors like you with our Pro Edition completely free, without any commitment. At Napptive our mission is to empower you with a self-service platform that speeds up and helps your development projects.

I did not opt in to your marketing.

I don’t know what this project is (and now I couldn’t care in the least), but shame on you for these trashy marketing techniques.

Add searching in `catalog list` command

Is your feature request related to a problem?

Right now there are so many applications in the public catalog, and even there might be so many under a single namespace. So it is quite challenging sometimes to find a particular application from the list.

Even though we have search functionalities in UI but not in the CLI.

Describe the solution you'd like

In the current impl command catalog list returns all the app from all the namespace. It can also take <namespace> as arg and print all app from that particular namespace.

My Proposal
Instead of taking the namespace as an argument, we can take that via a flag.
for eg: catalog list napptive will be catalog list -n napptive

Additionally, for searching we can send a Search String as an argument, with this we can match out the application name and print only that will match.

For example:

$./catalog list apache  # We can also add -n namespace-name  to specify a namespace

will print all the app that has "apache" in their name from all the namespace.

Describe alternatives you've considered

As an alternative, we can have a completely different sub command search that will search for an application with the same functionality mentioned above. and we can leave the list command as it is.

Add proper contribution guidelines to this project

I would like to request the maintainers of this repository that I would like to make some changes in the documentation part and also add some proper contribution guidelines for beginners to contribute to this project

@Carmendelope
@dhiguero

Recommend Projects

napptive / catalog-cli Goto Github PK