{"id":21923539,"url":"https://github.com/kuflow/kuflow-cli","last_synced_at":"2026-05-07T07:37:22.397Z","repository":{"id":65630009,"uuid":"578130662","full_name":"kuflow/kuflow-cli","owner":"kuflow","description":"KuFlow Command Line Interface","archived":false,"fork":false,"pushed_at":"2023-02-01T14:59:12.000Z","size":110,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-27T10:45:01.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kuflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-12-14T10:29:00.000Z","updated_at":"2022-12-21T13:58:57.000Z","dependencies_parsed_at":"2023-02-17T06:45:40.833Z","dependency_job_id":null,"html_url":"https://github.com/kuflow/kuflow-cli","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuflow%2Fkuflow-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuflow%2Fkuflow-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuflow%2Fkuflow-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuflow%2Fkuflow-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kuflow","download_url":"https://codeload.github.com/kuflow/kuflow-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244945625,"owners_count":20536297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-28T21:12:05.396Z","updated_at":"2026-05-07T07:37:22.367Z","avatar_url":"https://github.com/kuflow.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GitHub](https://img.shields.io/github/license/kuflow/kuflow-cli?label=License)](https://github.com/kuflow/kuflow-cli/blob/master/LICENSE)\n\n# KuFlow CLI\n\n\u003e ***\"KuFlow is a platform on which you can design and execute your business processes\"***\n\nIn KuFlow we are engineers and therefore we like concrete things; we like to know 'the how' because it is the only way to understand how a platform can solve our problems.\n\nThis project is a command-line client for KuFlow Rest API. \n\n## Installation\n\n**Important**. For its correct operation, it is necessary to have JAVA installed and available in the system path. The minimum version required is 11.\n\nDownload the archive from Github [releases](https://github.com/kuflow/kuflow-cli/releases), and unpack it to a location of your choice.\n\n## Usage\n\n### Available Commands\n\nDisplay the help to learn about using kuflowctl:\n\n```shell script\nkuflowctl --help\nUsage: kuflowctl [-hsVv] [--endpoint=\u003cendpoint\u003e]\n                 [--environment-file=\u003cenvironmentFile\u003e |\n                 (--client-id=\u003cclientId\u003e --client-secret=\u003cclientSecret\u003e)]\n                 [COMMAND]\n      --client-id=\u003cclientId\u003e\n                      The 'Application' identifier\n      --client-secret=\u003cclientSecret\u003e\n                      The 'Application' token\n      --endpoint=\u003cendpoint\u003e\n                      KuFlow Api endpoint. By default is https://api.kuflow.com\n      --environment-file=\u003cenvironmentFile\u003e\n                      Environment file in YAML format. More info: https:\n                        //github.com/kuflow/kuflow-cli\n  -h, --help          Show this help message and exit.\n  -s, --[no-]silent   Silent output. False by default.\n  -v, --verbose       Specify multiple -v options to increase verbosity.\n                      For example, `-v -v -v` or `-vvv`\n  -V, --version       Print version information and exit.\nCommands:\n  append-log\n  save-element-document\n  save-element-document-by-reference\n  save-element-field\n  save-element-principal\n```\n\n### Authentication\n\nTo connect to the KuFlow API it is necessary to have an identifier and password that must be configured in the *\"Applications\"* section of the administrative part of the KuFlow application. In addition, although it is not required by default, it is possible to explicitly specify the API access endpoint.\n\nWith this data, there are different ways to provision the CLI commands with this information. Through, command line options, configuration file or environment variables.\n\nThe order of precedence for locating this configuration is as follows:\n\n1. Command line options, through: \n   1. Individual options\n   2. Specified configuration file   \n2. Environment Variables   \n3. Default configuration file location\n   1. Try to locate a `.kuflow.yaml` file in the user's home directory\n\n#### Command line options\n\nWe have two options, indicate *Client Identifier* (`--client-id`) and *Client Secret* (-`-client-secret`) or indicate the path to a configuration file in YAML format that includes these settings. The format of the configuration file is as follows:\n\n```yaml\nkuflow:\n    # ID of the APPLICATION configured in KUFLOW.\n    # Get it in \"Application details\" in the Kuflow APP.\n    client-id: YOUR_IDENTIFIER\n\n    # TOKEN of the APPLICATION configured in KUFLOW.\n    # Get it in \"Application details\" in the Kuflow APP.\n    client-secret: YOUR_SECRET\n    \n    # OPTIONAL KUFLOW REST API. Default is: https://api.kuflow.com\n    #endpoint: https://api.kuflow.com\n```\n\nFor more information, see the application help with `kuflowctl --help`.\n\n#### Environment Variables\n\nIt is possible to specify settings in the following variables:\n\n```shell\nKUFLOW_CLIENT_ID=YOUR_IDENTIFIER\nKUFLOW_CLIENT_SECRET=YOUR_SECRET\n\n# OPTIONAL KUFLOW REST API. Default is: https://api.kuflow.com\n#KUFLOW_ENDPOINT=https://api.kuflow.com\n```\n## Documentation\n\nSee reference, examples and more in our [documentation](https://docs.kuflow.com/developers/kuflowctl/)\n\n## Contributing\n\nWe are happy to receive your help and comments, together we will dance a wonderful KuFlow. Please review our [contribution guide](CONTRIBUTING.md).\n\n## License\n\n[MIT License](https://github.com/kuflow/kuflow-engine-client-java/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuflow%2Fkuflow-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkuflow%2Fkuflow-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuflow%2Fkuflow-cli/lists"}