Reference

config_editor

Launch graphical KToolBox configuration editor

download_post

Download a specific post or revision

Parameters:

Name	Type	Description	Default
url	str	The post URL	None
service	str	The service name	None
creator_id	str	The creator's ID	None
post_id	str	The post ID	None
revision_id	str	The revision ID (optional, for revision posts)	None
path	Union[Path, str]	Download path, default is current directory	Path('.')
dump_post_data		Whether to dump post data (post.json) in post directory	True

example_env

Generate an example configuration .env file.

get_post

Get a specific post or revision

Parameters:

Name	Type	Description	Default
service	str	The service name	required
creator_id	str	The creator's ID	required
post_id	str	The post ID	required
revision_id	str	The revision ID (optional, for revision posts)	None
dump	Path	Dump the result to a JSON file	None

search_creator

Search creator, you can use multiple parameters as keywords.

Parameters:

Name	Type	Description	Default
id	str	The ID of the creator	None
name	str	The name of the creator	None
service	str	The service for the creator	None
dump	Path	Dump the result to a JSON file	None

search_creator_post

Search posts from creator, you can use multiple parameters as keywords.

Parameters:

Name	Type	Description	Default
id	str	The ID of the creator	None
name	str	The name of the creator	None
service	str	The service for the creator	None
q	str	Search query	None
o	int	Result offset, stepping of 50 is enforced	None
dump	Path	Dump the result to a JSON file	None

site_version

Show current Kemono site app commit hash

sync_creator

Sync posts from a creator

You can update the directory anytime after download finished, such as to update after creator published new posts.

• start_time & end_time example: 2023-12-7, 2023-12-07

Parameters:

Name	Type	Description	Default
url	str	The post URL	None
service	str	The service where the post is located	None
creator_id	str	The ID of the creator	None
path	Union[Path, str]	Download path, default is current directory	Path('.')
save_creator_indices	bool	Record CreatorIndices data	False
mix_posts	bool	Save all_pages files from different posts at same path, save_creator_indices will be ignored if enabled	None
start_time	str	Start time of the published time range for posts downloading. Set to 0 if None was given. Time format: %Y-%m-%d	None
end_time	str	End time of the published time range for posts downloading. Set to latest time (infinity) if None was given. Time format: %Y-%m-%d	None
offset	int	Result offset (or start offset)	0
length	int	The number of posts to fetch, defaults to fetching all posts after offset.	None
keywords	Tuple[str]	Comma-separated keywords to filter posts by title (case-insensitive)	None
keywords_exclude	Tuple[str]	Comma-separated keywords to exclude posts by title (case-insensitive)	None

version

Show KToolBox version