jisap CLI

Basic cli usage is based on DVC and git. Refer to dataset cli documentation.

jisap-cli binary offers extra functionality that it is not provided by dvc or git. It was born as a drop in replacement for cml, but quickly grow into something more useful.

The updated documentation is available at jisap-cli source code repository.

Reporting

Publish files

$ jisap-cli publish --help
Publish will upload a given image to the platform and generate a permanent url to it.
This url can be embedded into markdown code to create reports.
By default, the output of this command is markdown

Usage:
  jisap-cli publish [flags]

Flags:
      --content-type string   Specify a different content type
      --detect-content-type   DetectContentType implements the algorithm described at https://mimesniff.spec.whatwg.org/ to determine the Content-Type of the given data.
  -h, --help                  help for publish
      --remote string         dvc remote to use
  -u, --url                   Prints only the url

Comment

$ jisap-cli comment --help                                                         16:07:03
Publish a comment to the current commit,

Calls the GitLab api with the pipeline token to publish a new comment.
It replaces cml-publish

Usage:
  jisap-cli comment [flags]

Flags:
      --commit string          Commit to attach the comment, Also defined from env CI_COMMIT_SHA
      --gitlab-server string   GitLab api base url, Also defined from env CI_SERVER_URL
  -h, --help                   help for comment
      --project-id string      The project ID to perform the operation, Also defined from env
CI_PROJECT_ID
      --repo-token string      GitLab token used to post the comment, Also defined from env repo_token

Release

╰─>$ jisap-cli release --help                                                         16:07:21
Creates a new release in GitLab

Usage:
  jisap-cli release [flags]

Examples:
jisap-cli release --name "v0.5.1" --project-id 4453 --ref master --link jisap-cli --tag-name "v0.5.1" release.md

Flags:
      --gitlab-server string   GitLab api base url, Also defined from env CI_SERVER_URL
  -h, --help                   help for release
      --link strings           Relative path to the files under this repository to generate permanent urls, you can put as many as you want
      --name string            The release name, Also defined from env CI_COMMIT_TITLE
      --project-id string      The project ID to perform the operation, Also defined from env
CI_PROJECT_ID
      --ref string             If a tag specified in tag_name doesn’t exist, the release will
be created from ref and tagged with tag_name. It can be a commit SHA, another tag name, or a branch name., Also defined from env CI_COMMIT_SHA
      --remote string          dvc remote to use
      --tag-name string        The tag where the release will be created from