gitlab-x - npm Package Compare versions

Comparing version 0.1.9 to 0.1.10

index.js

@@ -16,3 +16,3 @@ #!/usr/bin/env node
 
-const version = "0.1.9";
+const version = "0.1.10";
  
@@ -19,0 +19,0 @@ const parser = new ArgumentParser({

package.json

 {
   "name": "gitlab-x",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "GitLab Executor API Interface",
@@ -5,0 +5,0 @@ "repository": "https://github.com/mxcd/gitlab-api",

README.md

@@ -21,2 +21,45 @@ ## gitlab-x
 ```
-npm gitlab-x -u gitlab.com -t asdf1234 version
+$ npx gitlab-x -u gitlab.com -t asdf1234 version
+```
+### Commands
+#### version
+Retrieves the version of the GitLab being queried  
+
+`$ npx gitlab-x version [fields...]`
+```
+$ npx gitlab-x version
+{ version: '13.7.0-pre', revision: '59e06a7bf82' }
+
+$ npx gitlab-x version revision
+'59e06a7bf82'
+
+$ npx gitlab-x version version
+'13.7.0-pre'
+
+$ npx gitlab-x version version --json
+{ version: '13.7.0-pre' }
+```
+#### get
+Queries API objects
+##### get project
+`$ npx gitlab-x get project <project_identifier> [fields...]`  
+The `project_identifier` can be either:
+- the project id as number
+- the project path relative to the GitLab root
+- the project url (basically base url and path combined)
+```
+$ npx gitlab-x get project /mxcd/test
+{
+  id: 23106572,
+  description: '',
+  name: 'test',
+  name_with_namespace: 'Max Partenfelder / test',
+  path: 'test',
+  path_with_namespace: 'mxcd/test',
+  created_at: '2020-12-14T23:26:00.959Z',
+  default_branch: null,
+  tag_list: [],
+  .....
+
+$ npx gitlab-x get project 23106572 name web_url
+{ name: 'test', web_url: 'https://gitlab.com/mxcd/test' }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14741

increased by7.59%

Number of lines in readme file

64

increased by204.76%

No dependency changes