Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
Appmonitor CLI client
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
IML Open Source
Appmonitor CLI client
Commits
adf5a616
Commit
adf5a616
authored
2 months ago
by
Hahn Axel (hahn)
Browse files
Options
Downloads
Patches
Plain Diff
add docs: usage
parent
59664048
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Usage.md
+70
-0
70 additions, 0 deletions
Usage.md
with
70 additions
and
0 deletions
Usage.md
0 → 100644
+
70
−
0
View file @
adf5a616
# Usage of amcli
## Show help
```
text
./src/amcli -h
IML Appmonitor as CLI client 0.1
This client performs appmonitor checks and puts the results as JSON to stdout.
You can use the compiled binary on non PHP systems.
(c) 2025 Institute for Medical education * University of Bern
SYNTAX: amcli [OPTIONS] --ini=<INI-FILE>
OPTIONS:
-h, --help Print this help and exit
-i, --ini Set an INI File to parse
-l, --list list available checks and exit
-m, --modules list available Php modules in this binary and exit
-v, --verbose Enable verbose output
-V, --version Show version and exit
EXAMPLES:
amcli -i=my.ini
amcli --ini=my.ini
Execute checks from INI file 'my.ini'.
amcli --list
List available checks.
```
## Execute checks
`amcli --ini=<FILENAME>`
## Exitcodes
### amcli
| Exitcode | Description
| --- | ---
| 0 | OK. An option was executed (help, list modules or checks) or the check was executed successfully
| 1 | include include_checks.php failed (php file only)
| 2 | include_checks.php failed (php file only)
| 3 | INI file was not given. Or missing
`=`
char in
`--ini=<FILE>`
| 4 | Given Ini file does not exist
| 5 | Given Ini file cannot be parsed
| 6 | Ini value
`params=`
is no JSON
### appmonitor-client.class.php
| Exitcode | Description
| --- | ---
| 10 | incomplete reponse data detected eg. no check, no result code
| 11 | Access denied: Ip restriction was set
| 12 | Access denied: No token or wrong token was given
### appmonitor-checks.class.php
| Exitcode | Description
| --- | ---
| 20 | Missing key in a given hash
| 21 | Mising value in a given hash
| 22 | Check not found. Check your
`function`
value
| 23 | Check didn't response a hash (=error in check)
| 24 | Check responded a too small hash (=error in check)
| 25 | The unit in a space value is unknown
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment