skywalking-cli
Apache SkyWalking CLI
File Explorer
Download Latest Version (.zip)- entrypoint.sh
- post-entrypoint.sh
- CI.yaml
- publish-docker.yaml
- file-filters.txt
- action.yaml
- oap.yaml
- ui.yaml
- alarms.graphql
- tagAutocompleteKeys.graphql
- tagAutocompleteValues.graphql
- version.graphql
- EndpointDependency.graphql
- GlobalTopology.graphql
- GlobalTopologyWithoutLayer.graphql
- InstanceTopology.graphql
- ProcessTopology.graphql
- ServiceTopology.graphql
- events.graphql
- healthcheck.graphql
- InstanceHierarchy.graphql
- ListLayerLevels.graphql
- ServiceHierarchy.graphql
- BrowserLogs.graphql
- Logs.graphql
- GetItems.graphql
- AllBrowserServices.graphql
- AllServices.graphql
- Instances.graphql
- SearchBrowserService.graphql
- SearchEndpoints.graphql
- SearchService.graphql
- ServerTimeInfo.graphql
- AllBrowserServices.graphql
- AllServices.graphql
- EstimateProcessScale.graphql
- FindEndpointsWithDuration.graphql
- FindEndpointsWithoutDuration.graphql
- FindService.graphql
- GetEndpointInfo.graphql
- GetInstance.graphql
- GetProcess.graphql
- Instances.graphql
- ListLayers.graphql
- ListService.graphql
- Processes.graphql
- SearchBrowserService.graphql
- ServerTimeInfo.graphql
- ExecuteExpression.graphql
- HeatMap.graphql
- LabeledMetricsValues.graphql
- ListMetrics.graphql
- MetricsValue.graphql
- MetricsValues.graphql
- NullableMetricsValue.graphql
- ReadRecords.graphql
- SampledRecords.graphql
- SortMetrics.graphql
- CreateTask.graphql
- GetAnalysis.graphql
- GetTaskList.graphql
- GetTaskProgress.graphql
- QueryContinuousProfilingMonitoringInstances.graphql
- QueryContinuousProfilingServiceTargets.graphql
- SetContinuousProfilingPolicy.graphql
- AnalysisEBPFProfilingResult.graphql
- CreateEBPFNetworkProfilingTask.graphql
- CreateEBPFProfilingFixedTimeTask.graphql
- KeepNetworkProfilingTask.graphql
- QueryEBPFProfilingScheduleList.graphql
- QueryEBPFProfilingTaskList.graphql
- QueryPrepareCreateEBPFProfilingTaskData.graphql
- CreateTask.graphql
- GetAnalysis.graphql
- GetTaskList.graphql
- GetTaskProgress.graphql
- CreateTask.graphql
- GetProfiledSegment.graphql
- GetProfileTaskLogs.graphql
- GetSegmentsProfileAnalyze.graphql
- GetTaskList.graphql
- GetTaskSegmentsList.graphql
- Trace.graphql
- Traces.graphql
- TraceWithoutDuration.graphql
- Traces.graphql
- global.yml
- assets.go
- assets_test.go
- main.go
- license-dario.cat-mergo.txt
- license-github.com-apache-skywalking-swck-operator.txt
- license-github.com-beorn7-perks.txt
- license-github.com-BurntSushi-toml.txt
- license-github.com-cespare-xxhash-v2.txt
- license-github.com-cpuguy83-go-md2man-v2.txt
- license-github.com-davecgh-go-spew.txt
- license-github.com-emicklei-go-restful-v3.txt
- license-github.com-evanphx-json-patch-v5.txt
- license-github.com-evanphx-json-patch.txt
- license-github.com-fsnotify-fsnotify.txt
- license-github.com-fxamacker-cbor-v2.txt
- license-github.com-ghodss-yaml.txt
- license-github.com-gizak-termui-v3.txt
- license-github.com-go-logr-logr.txt
- license-github.com-go-openapi-jsonpointer.txt
- license-github.com-go-openapi-jsonreference.txt
- license-github.com-go-openapi-swag.txt
- license-github.com-gogo-protobuf.txt
- license-github.com-golang-groupcache.txt
- license-github.com-golang-protobuf.txt
- license-github.com-google-btree.txt
- license-github.com-google-gnostic-models.txt
- license-github.com-google-go-cmp.txt
- license-github.com-google-gofuzz.txt
- license-github.com-google-uuid.txt
- license-github.com-googleapis-gnostic.txt
- license-github.com-hashicorp-hcl.txt
- license-github.com-huandu-xstrings.txt
- license-github.com-imdario-mergo.txt
- license-github.com-josharian-intern.txt
- license-github.com-json-iterator-go.txt
- license-github.com-machinebox-graphql.txt
- license-github.com-magiconair-properties.txt
- license-github.com-mailru-easyjson.txt
- license-github.com-Masterminds-goutils.txt
- license-github.com-Masterminds-semver-v3.txt
- license-github.com-Masterminds-sprig-v3.txt
- license-github.com-matryer-is.txt
- license-github.com-mattn-go-runewidth.txt
- license-github.com-matttproud-golang-protobuf-extensions.txt
- license-github.com-mitchellh-copystructure.txt
- license-github.com-mitchellh-go-wordwrap.txt
- license-github.com-mitchellh-mapstructure.txt
- license-github.com-mitchellh-reflectwalk.txt
- license-github.com-modern-go-concurrent.txt
- license-github.com-modern-go-reflect2.txt
- license-github.com-mum4k-termdash.txt
- license-github.com-munnerz-goautoneg.txt
- license-github.com-nsf-termbox-go.txt
- license-github.com-olekukonko-tablewriter.txt
- license-github.com-pelletier-go-toml.txt
- license-github.com-pkg-errors.txt
- license-github.com-prometheus-client-golang.txt
- license-github.com-prometheus-client-model.txt
- license-github.com-prometheus-common.txt
- license-github.com-prometheus-procfs.txt
- license-github.com-russross-blackfriday-v2.txt
- license-github.com-shopspring-decimal.txt
- license-github.com-sirupsen-logrus.txt
- license-github.com-spf13-afero.txt
- license-github.com-spf13-cast.txt
- license-github.com-spf13-jwalterweatherman.txt
- license-github.com-spf13-pflag.txt
- license-github.com-spf13-viper.txt
- license-github.com-subosito-gotenv.txt
- license-github.com-urfave-cli-v2.txt
- license-github.com-x448-float16.txt
- license-golang.org-x-crypto.txt
- license-golang.org-x-net.txt
- license-golang.org-x-oauth2.txt
- license-golang.org-x-sync.txt
- license-golang.org-x-sys.txt
- license-golang.org-x-term.txt
- license-golang.org-x-text.txt
- license-golang.org-x-time.txt
- license-gomodules.xyz-jsonpatch-v2.txt
- license-google.golang.org-appengine.txt
- license-google.golang.org-genproto-googleapis-rpc.txt
- license-google.golang.org-genproto.txt
- license-google.golang.org-grpc.txt
- license-google.golang.org-protobuf.txt
- license-gopkg.in-evanphx-json-patch.v4.txt
- license-gopkg.in-inf.v0.txt
- license-gopkg.in-ini.v1.txt
- license-gopkg.in-yaml.v2.txt
- license-gopkg.in-yaml.v3.txt
- license-k8s.io-api.txt
- license-k8s.io-apiextensions-apiserver.txt
- license-k8s.io-apimachinery.txt
- license-k8s.io-client-go.txt
- license-k8s.io-component-base.txt
- license-k8s.io-klog-v2.txt
- license-k8s.io-kube-openapi.txt
- license-k8s.io-utils.txt
- license-sigs.k8s.io-controller-runtime.txt
- license-sigs.k8s.io-json.txt
- license-sigs.k8s.io-randfill.txt
- license-sigs.k8s.io-structured-merge-diff-v4.txt
- license-sigs.k8s.io-yaml.txt
- license-skywalking.apache.org-repo-goapi.txt
- LICENSE
- LICENSE.tpl
- NOTICE
- How-to-release.md
- .skywalking.yaml
- assets.go
- continuous-profiling.yaml
- global.yml
- network-sampling.yaml
- alarm.go
- cluster.go
- config.go
- dsldebug.go
- inspect.go
- oal.go
- runtimerule.go
- uitemplate.go
- admin.go
- preflight.go
- alarm.go
- autopleteKeys.go
- autopleteValues.go
- list.go
- list.go
- log.go
- list.go
- page.go
- list.go
- service.go
- list.go
- version.go
- browser.go
- bash.go
- completion.go
- fish.go
- powershell.go
- zsh.go
- global.go
- metrics.go
- dashboard.go
- dependency.go
- endpoint.go
- global.go
- instance.go
- process.go
- service.go
- endpoint.go
- get.go
- list.go
- event.go
- list.go
- report.go
- healthcheck.go
- hierarchy.go
- instance.go
- layers.go
- service.go
- manifest.go
- oap.go
- ui.go
- install.go
- get.go
- instance.go
- list.go
- search.go
- duration.go
- duration_test.go
- endpoint.go
- entity.go
- event.go
- event_test.go
- instance.go
- interceptor.go
- page.go
- process.go
- service.go
- timezone.go
- version.go
- layer.go
- list.go
- list.go
- log.go
- get.go
- menu.go
- metrics.go
- sampled-record.go
- sorted-condition.go
- topn.go
- exec.go
- linear-metrics.go
- multiple-linear-metrics.go
- list-metrics.go
- nullable-metrics.go
- single-metrics.go
- thermodynamic.go
- metrics.go
- estimate.go
- scale.go
- get.go
- list.go
- process.go
- asyncprofiler.go
- create.go
- getAnalyze.go
- getTaskList.go
- getTaskProgress.go
- continuous.go
- list.go
- monitoring.go
- set.go
- create.go
- createByFixedTime.go
- network.go
- prepareCreate.go
- keep.go
- network.go
- analysis.go
- ebpf.go
- list.go
- schedules.go
- create.go
- getAnalyze.go
- getTaskList.go
- getTaskProgress.go
- pprof.go
- create.go
- getProfileAnalyze.go
- getTaskList.go
- getTaskLogs.go
- getTaskSegmentList.go
- trace.go
- profiling.go
- list.go
- records.go
- layer.go
- list.go
- service.go
- list.go
- trace.go
- list.go
- tracev2.go
- display.go
- duration.go
- endpoint.go
- flags.go
- instance.go
- metrics.go
- page.go
- process.go
- search.go
- service.go
- version.go
- asyncProfilerEventType.go
- jfrEventType.go
- profilingAnalyzeAggregateType.go
- profilingTargetType.go
- profilingTriggerType.go
- pprofEventType.go
- order.go
- scope.go
- step.go
- type.go
- commandNotFound.go
- commandNotFound_test.go
- client.go
- client_test.go
- dsldebug.go
- inspect.go
- oal.go
- preflight.go
- runtimerule.go
- status.go
- uitemplate.go
- contextkey.go
- displayable.go
- MetricValue.go
- global.go
- adapter.go
- flamegraph.go
- flamegraph.html
- render.go
- gauge.go
- heatmap.go
- linear.go
- adapter.go
- list.go
- tree.go
- graph.go
- json.go
- json_test.go
- table.go
- table_test.go
- yaml.go
- yaml_test.go
- display.go
- alarm.go
- client.go
- common.go
- global.go
- dependency.go
- event.go
- healthcheck.go
- hierarchy.go
- log.go
- menu.go
- metadata.go
- metrics.go
- asyncprofiler.go
- continuous.go
- ebpf.go
- pprof.go
- trace.go
- trace.go
- trace.go
- adapter.go
- adapter_test.go
- constants.go
- parser.go
- parser_test.go
- grpc.go
- grpc.go
- axes.go
- label.go
- heatmap.go
- options.go
- log.go
- transport.go
- io.go
- lang.go
- math.go
- template.go
- boilerplate.go.txt
- build-header.sh
- install.bat
- install.sh
- install_protoc.sh
- pre-release.sh
- release.sh
- consumer.py
- provider.py
- docker-compose.yml
- count.yml
- ok.yml
- true.yml
- docker-compose.yml
- test.yaml
- dashboard-global-metrics.yml
- dashboard-global.yml
- dependency-endpoint.yml
- dependency-instance.yml
- dependency-service.yml
- empty-array.yml
- endpoint-get.yml
- endpoint-list.yml
- instance-get.yml
- instance-list.yml
- layer-list.yml
- metrics-has-value.yml
- metrics-top-endpoint-sla-provider.yml
- metrics-top-service-sla.yml
- service-endpoint.yml
- service-provider.yml
- service.yml
- value.yml
- docker-compose.yml
- test.yaml
- ok.yml
- docker-compose.yml
- oal-debug-flow.sh
- test.yaml
- .asf.yaml
- .gitignore
- .golangci.yml
- .graphqlconfig
- .licenserc.yaml
- action.yaml
- CHANGES.md
- CONTRIBUTING.md
- Dockerfile
- go.mod
- go.sum
- LICENSE
- Makefile
- NOTICE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/apache/skywalking-cli
Downloads the entire project code from GitHub to your computer.
cd skywalking-cli
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
brew install swctl
Installs the pre-built package via Homebrew โ no source build required.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -it --rm apache/skywalking-cli service ls
Runs the built image as an actual container.
docker run -it --rm ghcr.io/apache/skywalking-cli/skywalking-cli service ls
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Go
MediumPrerequisites
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)