asyncapi / asyncapi/cli

[Docs Bug 🐞 report]: Broken links on docs/tools/cli/usage page

Open
#1,968 5 comments 0 reactions 0 assignees View on GitHub
🐞 docs bug stale
Dominant language
TypeScript
Stars
272
Forks
375
Avg merge
3h 22m
Merged PRs (30d)
8

Description

### Describe the bug you found in AsyncAPI Docs.

**Page affected**
[https://www.asyncapi.com/docs/tools/cli/usage](https://www.asyncapi.com/docs/tools/cli/usage)

**Description**
The CLI usage documentation contains multiple broken GitHub links. Most links point to versioned paths that no longer exist (`v5.0.1` or incorrect tag format) and should instead reference the current repository structure under `master/src/apps/cli/commands`.

**Broken links and expected targets**

1. **@oclif/plugin-autocomplete**
Current:
[https://github.com/oclif/plugin-autocomplete/blob/v3.2.39/src/commands/autocomplete/index.ts](https://github.com/oclif/plugin-autocomplete/blob/v3.2.39/src/commands/autocomplete/index.ts)
Expected:
[https://github.com/oclif/plugin-autocomplete/blob/3.2.39/src/commands/autocomplete/index.ts](https://github.com/oclif/plugin-autocomplete/blob/3.2.39/src/commands/autocomplete/index.ts)

2. **src/commands/bundle.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/bundle.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/bundle.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/bundle.ts)

3. **src/commands/config/index.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/index.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/index.ts)

4. **src/commands/config/analytics.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/analytics.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/analytics.ts)

5. **src/commands/config/auth/add.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/auth/add.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/auth/add.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/auth/add.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/auth/add.ts)

6. **src/commands/config/context/current.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/current.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/current.ts)

7. **src/commands/config/context/edit.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/edit.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/edit.ts)

8. **src/commands/config/context/init.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/init.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/init.ts)

9. **src/commands/config/context/list.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/list.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/list.ts)

10. **src/commands/config/context/remove.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/remove.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/remove.ts)

11. **src/commands/config/context/use.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/use.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/use.ts)

12. **src/commands/config/versions.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/versions.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/versions.ts)

13. **src/commands/convert.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/convert.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/convert.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/convert.ts)

14. **src/commands/diff.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/diff.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/diff.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/diff.ts)

15. **src/commands/format.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/format.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/format.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/format.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/format.ts)

16. **src/commands/generate/index.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/index.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/index.ts)

17. **src/commands/generate/client.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/client.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/client.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/client.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/client.ts)

18. **src/commands/generate/fromTemplate.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/fromTemplate.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/fromTemplate.ts)

19. **src/commands/generate/models.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/models.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/models.ts)

20. **src/commands/new/index.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/index.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/index.ts)

21. **src/commands/new/file.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/file.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/file.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/file.ts)

22. **src/commands/new/template.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/template.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/template.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/template.ts)

23. **src/commands/optimize.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/optimize.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/optimize.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/optimize.ts)

24. **src/commands/pretty.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/pretty.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/pretty.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/pretty.ts)

25. **src/commands/start/index.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/index.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/index.ts)

26. **src/commands/start/api.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/api.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/api.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/api.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/api.ts)

27. **src/commands/start/preview.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/preview.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/preview.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/preview.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/preview.ts)

28. **src/commands/start/studio.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/studio.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/studio.ts)

29. **src/commands/validate.ts**
Current:
[https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/validate.ts)
Expected:
[https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/validate.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/validate.ts)

### Attach any resources that can help us understand the issue.

Image

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

### Are you willing to work on this issue ?

Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.