Repository navigation
docs: move feed listing into a separate guide #327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| title: "List registered feeds" | ||
| description: "List registered feeds and inspect their state without generating files" | ||
| type: guide | ||
| status: stable | ||
| since: "2.1.0" | ||
| keywords: ["feed:list", "registered feeds", "registrations", "AI agents"] | ||
| --- | ||
|
|
||
| [← Previous](./create-feeds.mdx) · [Back to README](https://github.com/TheDragonCode/laravel-feeds#readme) · [Next →](./generation.mdx) | ||
|
|
||
| # List registered feeds {/* #list_feeds */} | ||
|
|
||
| Starting with version 2.1.0, list feed registrations without generating files or changing their state: | ||
|
|
||
| ```bash | ||
| php artisan feed:list | ||
| ``` | ||
|
|
||
| The command has no custom arguments or options. It displays a table with all registrations, including inactive and soft-deleted feeds. | ||
|
|
||
| | Column | Meaning | | ||
| | --- | --- | | ||
| | `id` | Registration ID. | | ||
| | `slug` | Registration slug used by `feed:generate`. | | ||
| | `title` | Registration title. | | ||
| | `expression` | Stored cron expression. | | ||
| | `is_active` | Whether the registration is enabled. | | ||
| | `is_deleted` | Whether the registration is soft-deleted. | | ||
| | `last_activity` | Last recorded generation time in ISO 8601; `null` in JSON when unset. | | ||
|
|
||
| Non-deleted registrations appear first, followed by soft-deleted registrations. Within each group, active feeds appear first, then rows are sorted by title and ID. Boolean values appear as `true` or `false` in the console. | ||
|
|
||
| Use a non-deleted registration's slug to generate that feed: | ||
|
|
||
| ```bash | ||
| php artisan feed:generate products | ||
| ``` | ||
|
|
||
| If no registrations exist, the console displays `No feeds available`. | ||
|
|
||
| ## AI agent listing {/* #list_feeds_agent */} | ||
|
|
||
| Inside a recognized AI coding agent, `feed:list` automatically returns one compact JSON object on a single line. No extra option is required. Boolean fields remain JSON booleans: | ||
|
|
||
| ```json | ||
| { | ||
| "tool": "feed:list", | ||
| "result": "success", | ||
| "feeds": [ | ||
| { | ||
| "id": 1, | ||
| "slug": "products", | ||
| "title": "Products", | ||
| "expression": "0 * * * *", | ||
| "is_active": true, | ||
| "is_deleted": false, | ||
| "last_activity": null | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| The example is formatted for readability. An empty listing returns the same envelope with `"feeds": []`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
docs/i18n/be/docusaurus-plugin-content-docs/current/list-feeds.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| title: "Спіс зарэгістраваных стужак" | ||
| description: "Прагляд зарэгістраваных стужак і іх стану без генерацыі файлаў" | ||
| type: guide | ||
| status: stable | ||
| since: "2.1.0" | ||
| keywords: ["feed:list", "registered feeds", "registrations", "AI agents"] | ||
| --- | ||
|
|
||
| [← Папярэдняя](./create-feeds.mdx) · [Назад да README](https://github.com/TheDragonCode/laravel-feeds#readme) · [Наступная →](./generation.mdx) | ||
|
|
||
| # Спіс зарэгістраваных стужак {/* #list_feeds */} | ||
|
|
||
| Пачынаючы з версіі 2.1.0, можна праглядаць рэгістрацыі стужак без генерацыі файлаў або змянення іх стану: | ||
|
|
||
| ```bash | ||
| php artisan feed:list | ||
| ``` | ||
|
|
||
| Каманда не мае ўласных аргументаў або параметраў. Яна паказвае табліцу ўсіх рэгістрацый, у тым ліку неактыўных і мякка выдаленых стужак. | ||
|
|
||
| | Слупок | Значэнне | | ||
| | --- | --- | | ||
| | `id` | Ідэнтыфікатар рэгістрацыі. | | ||
| | `slug` | Slug рэгістрацыі, які выкарыстоўвае `feed:generate`. | | ||
| | `title` | Назва рэгістрацыі. | | ||
| | `expression` | Захаваны выраз cron. | | ||
| | `is_active` | Ці ўключана рэгістрацыя. | | ||
| | `is_deleted` | Ці мякка выдалена рэгістрацыя. | | ||
| | `last_activity` | Апошні запісаны час генерацыі ў фармаце ISO 8601; `null` у JSON, калі не зададзены. | | ||
|
|
||
| Спачатку паказваюцца нявыдаленыя рэгістрацыі, затым — мякка выдаленыя. У кожнай групе актыўныя стужкі ідуць першымі, далей радкі сартуюцца па назве і ідэнтыфікатары. Лагічныя значэнні ў кансолі паказваюцца як `true` або `false`. | ||
|
|
||
| Каб згенераваць стужку, выкарыстоўвайце slug нявыдаленай рэгістрацыі: | ||
|
|
||
| ```bash | ||
| php artisan feed:generate products | ||
| ``` | ||
|
|
||
| Калі рэгістрацый няма, кансоль паказвае `No feeds available`. | ||
|
|
||
| ## Спіс для ШІ-агента {/* #list_feeds_agent */} | ||
|
|
||
| Унутры распазнанага агента праграмавання са штучным інтэлектам `feed:list` аўтаматычна вяртае адзін кампактны аб'ект JSON у адзін радок. Дадатковы параметр не патрэбны. Лагічныя палі застаюцца лагічнымі значэннямі JSON: | ||
|
|
||
| ```json | ||
| { | ||
| "tool": "feed:list", | ||
| "result": "success", | ||
| "feeds": [ | ||
| { | ||
| "id": 1, | ||
| "slug": "products", | ||
| "title": "Products", | ||
| "expression": "0 * * * *", | ||
| "is_active": true, | ||
| "is_deleted": false, | ||
| "last_activity": null | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Прыклад адфарматаваны для зручнасці чытання. Пусты спіс вяртаецца ў той жа абалонцы з `"feeds": []`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.